blob: 393ccce80a0690970d09e9f259086b356b01a860 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="androidpublisher_v1.html">Google Play Developer API</a> . <a href="androidpublisher_v1.purchases.html">purchases</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(packageName, subscriptionId, token)</a></code></p>
79<p class="firstline">Cancels a user's subscription purchase. The subscription remains valid until its expiration time.</p>
80<p class="toc_element">
81 <code><a href="#get">get(packageName, subscriptionId, token)</a></code></p>
82<p class="firstline">Checks whether a user's subscription purchase is valid and returns its expiry time.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="cancel">cancel(packageName, subscriptionId, token)</code>
86 <pre>Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
87
88Args:
89 packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
90 subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
91 token: string, The token provided to the user's device when the subscription was purchased. (required)
92</pre>
93</div>
94
95<div class="method">
96 <code class="details" id="get">get(packageName, subscriptionId, token)</code>
97 <pre>Checks whether a user's subscription purchase is valid and returns its expiry time.
98
99Args:
100 packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
101 subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
102 token: string, The token provided to the user's device when the subscription was purchased. (required)
103
104Returns:
105 An object of the form:
106
107 { # A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
108 "initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since the Epoch.
109 "kind": "androidpublisher#subscriptionPurchase", # This kind represents a subscriptionPurchase object in the androidpublisher service.
110 "autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time.
111 "validUntilTimestampMsec": "A String", # Time at which the subscription will expire, in milliseconds since the Epoch.
112 }</pre>
113</div>
114
115</body></html>