Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / dyn / reseller_v1.subscriptions.html
blob: d9b420d93d6b53906a391f11a90694d144b368b1 [file] [log] [blame]
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]1<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="reseller_v1.html">Enterprise Apps Reseller API</a> . <a href="reseller_v1.subscriptions.html">subscriptions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#changePlan">changePlan(customerId, subscriptionId, body)</a></code></p>
79<p class="firstline">Changes the plan of a subscription</p>
80<p class="toc_element">
81 <code><a href="#changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</a></code></p>
82<p class="firstline">Changes the renewal settings of a subscription</p>
83<p class="toc_element">
84 <code><a href="#changeSeats">changeSeats(customerId, subscriptionId, body)</a></code></p>
85<p class="firstline">Changes the seats configuration of a subscription</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(customerId, subscriptionId, deletionType)</a></code></p>
88<p class="firstline">Cancels/Downgrades a subscription.</p>
89<p class="toc_element">
90 <code><a href="#get">get(customerId, subscriptionId)</a></code></p>
91<p class="firstline">Gets a subscription of the customer.</p>
92<p class="toc_element">
93 <code><a href="#insert">insert(customerId, body, customerAuthToken=None)</a></code></p>
94<p class="firstline">Creates/Transfers a subscription for the customer.</p>
95<p class="toc_element">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]96 <code><a href="#list">list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)</a></code></p>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]97<p class="firstline">Lists subscriptions of a reseller, optionally filtered by a customer name prefix.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#startPaidService">startPaidService(customerId, subscriptionId)</a></code></p>
103<p class="firstline">Starts paid service of a trial subscription</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="changePlan">changePlan(customerId, subscriptionId, body)</code>
107 <pre>Changes the plan of a subscription
108
109Args:
110 customerId: string, Id of the Customer (required)
111 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
112 body: object, The request body. (required)
113 The object takes the form of:
114
115{ # JSON template for the ChangePlan rpc request.
116 "planName": "A String", # Name of the plan to change to.
117 "kind": "subscriptions#changePlanRequest", # Identifies the resource as a subscription change plan request.
118 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
119 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
120 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
121 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
122 },
123 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
124 }
125
126
127Returns:
128 An object of the form:
129
130 { # JSON template for a subscription.
131 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
132 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
133 "renewalType": "A String", # Subscription renewal type.
134 },
135 "skuId": "A String", # Name of the sku for which this subscription is purchased.
136 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
137 "trialSettings": { # Trial Settings of the subscription.
138 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
139 "isInTrial": True or False, # Whether the subscription is in trial.
140 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]141 "transferInfo": { # Transfer related information for the subscription.
142 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
143 "minimumTransferableSeats": 42,
144 },
145 "resourceUiUrl": "A String", # Ui url for subscription resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]146 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
147 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
148 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
149 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
150 },
151 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]152 "status": "A String", # Status of the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]153 "plan": { # Plan details of the subscription
154 "planName": "A String", # The plan name of this subscription's plan.
155 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
156 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
157 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
158 },
159 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
160 },
161 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
162 "subscriptionId": "A String", # The id of the subscription.
163 "customerId": "A String", # The id of the customer to whom the subscription belongs.
164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</code>
169 <pre>Changes the renewal settings of a subscription
170
171Args:
172 customerId: string, Id of the Customer (required)
173 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
174 body: object, The request body. (required)
175 The object takes the form of:
176
177{ # JSON template for a subscription renewal settings.
178 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
179 "renewalType": "A String", # Subscription renewal type.
180}
181
182
183Returns:
184 An object of the form:
185
186 { # JSON template for a subscription.
187 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
188 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
189 "renewalType": "A String", # Subscription renewal type.
190 },
191 "skuId": "A String", # Name of the sku for which this subscription is purchased.
192 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
193 "trialSettings": { # Trial Settings of the subscription.
194 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
195 "isInTrial": True or False, # Whether the subscription is in trial.
196 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]197 "transferInfo": { # Transfer related information for the subscription.
198 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
199 "minimumTransferableSeats": 42,
200 },
201 "resourceUiUrl": "A String", # Ui url for subscription resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]202 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
203 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
204 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
205 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
206 },
207 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]208 "status": "A String", # Status of the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]209 "plan": { # Plan details of the subscription
210 "planName": "A String", # The plan name of this subscription's plan.
211 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
212 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
213 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
214 },
215 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
216 },
217 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
218 "subscriptionId": "A String", # The id of the subscription.
219 "customerId": "A String", # The id of the customer to whom the subscription belongs.
220 }</pre>
221</div>
222
223<div class="method">
224 <code class="details" id="changeSeats">changeSeats(customerId, subscriptionId, body)</code>
225 <pre>Changes the seats configuration of a subscription
226
227Args:
228 customerId: string, Id of the Customer (required)
229 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
230 body: object, The request body. (required)
231 The object takes the form of:
232
233{ # JSON template for subscription seats.
234 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
235 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
236 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
237}
238
239
240Returns:
241 An object of the form:
242
243 { # JSON template for a subscription.
244 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
245 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
246 "renewalType": "A String", # Subscription renewal type.
247 },
248 "skuId": "A String", # Name of the sku for which this subscription is purchased.
249 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
250 "trialSettings": { # Trial Settings of the subscription.
251 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
252 "isInTrial": True or False, # Whether the subscription is in trial.
253 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]254 "transferInfo": { # Transfer related information for the subscription.
255 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
256 "minimumTransferableSeats": 42,
257 },
258 "resourceUiUrl": "A String", # Ui url for subscription resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]259 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
260 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
261 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
262 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
263 },
264 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]265 "status": "A String", # Status of the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]266 "plan": { # Plan details of the subscription
267 "planName": "A String", # The plan name of this subscription's plan.
268 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
269 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
270 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
271 },
272 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
273 },
274 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
275 "subscriptionId": "A String", # The id of the subscription.
276 "customerId": "A String", # The id of the customer to whom the subscription belongs.
277 }</pre>
278</div>
279
280<div class="method">
281 <code class="details" id="delete">delete(customerId, subscriptionId, deletionType)</code>
282 <pre>Cancels/Downgrades a subscription.
283
284Args:
285 customerId: string, Id of the Customer (required)
286 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
287 deletionType: string, Whether the subscription is to be fully cancelled or downgraded (required)
288 Allowed values
289 cancel - Cancels the subscription immediately
290 downgrade - Downgrades a Google Apps for Business subscription to Google Apps
291 suspend - Suspends the subscriptions for 4 days before cancelling it
292</pre>
293</div>
294
295<div class="method">
296 <code class="details" id="get">get(customerId, subscriptionId)</code>
297 <pre>Gets a subscription of the customer.
298
299Args:
300 customerId: string, Id of the Customer (required)
301 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
302
303Returns:
304 An object of the form:
305
306 { # JSON template for a subscription.
307 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
308 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
309 "renewalType": "A String", # Subscription renewal type.
310 },
311 "skuId": "A String", # Name of the sku for which this subscription is purchased.
312 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
313 "trialSettings": { # Trial Settings of the subscription.
314 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
315 "isInTrial": True or False, # Whether the subscription is in trial.
316 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]317 "transferInfo": { # Transfer related information for the subscription.
318 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
319 "minimumTransferableSeats": 42,
320 },
321 "resourceUiUrl": "A String", # Ui url for subscription resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]322 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
323 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
324 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
325 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
326 },
327 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]328 "status": "A String", # Status of the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]329 "plan": { # Plan details of the subscription
330 "planName": "A String", # The plan name of this subscription's plan.
331 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
332 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
333 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
334 },
335 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
336 },
337 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
338 "subscriptionId": "A String", # The id of the subscription.
339 "customerId": "A String", # The id of the customer to whom the subscription belongs.
340 }</pre>
341</div>
342
343<div class="method">
344 <code class="details" id="insert">insert(customerId, body, customerAuthToken=None)</code>
345 <pre>Creates/Transfers a subscription for the customer.
346
347Args:
348 customerId: string, Id of the Customer (required)
349 body: object, The request body. (required)
350 The object takes the form of:
351
352{ # JSON template for a subscription.
353 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
354 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
355 "renewalType": "A String", # Subscription renewal type.
356 },
357 "skuId": "A String", # Name of the sku for which this subscription is purchased.
358 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
359 "trialSettings": { # Trial Settings of the subscription.
360 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
361 "isInTrial": True or False, # Whether the subscription is in trial.
362 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]363 "transferInfo": { # Transfer related information for the subscription.
364 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
365 "minimumTransferableSeats": 42,
366 },
367 "resourceUiUrl": "A String", # Ui url for subscription resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]368 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
369 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
370 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
371 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
372 },
373 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]374 "status": "A String", # Status of the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]375 "plan": { # Plan details of the subscription
376 "planName": "A String", # The plan name of this subscription's plan.
377 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
378 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
379 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
380 },
381 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
382 },
383 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
384 "subscriptionId": "A String", # The id of the subscription.
385 "customerId": "A String", # The id of the customer to whom the subscription belongs.
386 }
387
388 customerAuthToken: string, An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.
389
390Returns:
391 An object of the form:
392
393 { # JSON template for a subscription.
394 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
395 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
396 "renewalType": "A String", # Subscription renewal type.
397 },
398 "skuId": "A String", # Name of the sku for which this subscription is purchased.
399 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
400 "trialSettings": { # Trial Settings of the subscription.
401 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
402 "isInTrial": True or False, # Whether the subscription is in trial.
403 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]404 "transferInfo": { # Transfer related information for the subscription.
405 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
406 "minimumTransferableSeats": 42,
407 },
408 "resourceUiUrl": "A String", # Ui url for subscription resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]409 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
410 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
411 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
412 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
413 },
414 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]415 "status": "A String", # Status of the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]416 "plan": { # Plan details of the subscription
417 "planName": "A String", # The plan name of this subscription's plan.
418 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
419 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
420 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
421 },
422 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
423 },
424 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
425 "subscriptionId": "A String", # The id of the subscription.
426 "customerId": "A String", # The id of the customer to whom the subscription belongs.
427 }</pre>
428</div>
429
430<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]431 <code class="details" id="list">list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)</code>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]432 <pre>Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
433
434Args:
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]435 customerAuthToken: string, An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]436 pageToken: string, Token to specify next page in the list
437 maxResults: integer, Maximum number of results to return
438 customerNamePrefix: string, Prefix of the customer's domain name by which the subscriptions should be filtered. Optional
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]439 customerId: string, Id of the Customer
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]440
441Returns:
442 An object of the form:
443
444 { # JSON template for a subscription list.
445 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
446 "kind": "reseller#subscriptions", # Identifies the resource as a collection of subscriptions.
447 "subscriptions": [ # The subscriptions in this page of results.
448 { # JSON template for a subscription.
449 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
450 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
451 "renewalType": "A String", # Subscription renewal type.
452 },
453 "skuId": "A String", # Name of the sku for which this subscription is purchased.
454 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
455 "trialSettings": { # Trial Settings of the subscription.
456 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
457 "isInTrial": True or False, # Whether the subscription is in trial.
458 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]459 "transferInfo": { # Transfer related information for the subscription.
460 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
461 "minimumTransferableSeats": 42,
462 },
463 "resourceUiUrl": "A String", # Ui url for subscription resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]464 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
465 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
466 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
467 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
468 },
469 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]470 "status": "A String", # Status of the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]471 "plan": { # Plan details of the subscription
472 "planName": "A String", # The plan name of this subscription's plan.
473 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
474 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
475 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
476 },
477 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
478 },
479 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
480 "subscriptionId": "A String", # The id of the subscription.
481 "customerId": "A String", # The id of the customer to whom the subscription belongs.
482 },
483 ],
484 }</pre>
485</div>
486
487<div class="method">
488 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
489 <pre>Retrieves the next page of results.
490
491Args:
492 previous_request: The request for the previous page. (required)
493 previous_response: The response from the request for the previous page. (required)
494
495Returns:
496 A request object that you can call 'execute()' on to request the next
497 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]498 </pre>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]499</div>
500
501<div class="method">
502 <code class="details" id="startPaidService">startPaidService(customerId, subscriptionId)</code>
503 <pre>Starts paid service of a trial subscription
504
505Args:
506 customerId: string, Id of the Customer (required)
507 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
508
509Returns:
510 An object of the form:
511
512 { # JSON template for a subscription.
513 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
514 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
515 "renewalType": "A String", # Subscription renewal type.
516 },
517 "skuId": "A String", # Name of the sku for which this subscription is purchased.
518 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
519 "trialSettings": { # Trial Settings of the subscription.
520 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
521 "isInTrial": True or False, # Whether the subscription is in trial.
522 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]523 "transferInfo": { # Transfer related information for the subscription.
524 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
525 "minimumTransferableSeats": 42,
526 },
527 "resourceUiUrl": "A String", # Ui url for subscription resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]528 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
529 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
530 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
531 "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
532 },
533 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]534 "status": "A String", # Status of the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]535 "plan": { # Plan details of the subscription
536 "planName": "A String", # The plan name of this subscription's plan.
537 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
538 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
539 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
540 },
541 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
542 },
543 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
544 "subscriptionId": "A String", # The id of the subscription.
545 "customerId": "A String", # The id of the customer to whom the subscription belongs.
546 }</pre>
547</div>
548
549</body></html>