Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0e5b9bfd8a498fec87ed1237a0ed383f9329ed8f / . / docs / dyn / reseller_v1.subscriptions.html
blob: 9aed40ba1fc5fd36114e6952250e24ff7f4de97d [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]78 <code><a href="#activate">activate(customerId, subscriptionId)</a></code></p>
79<p class="firstline">Activates a subscription previously suspended by the reseller</p>
80<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]81 <code><a href="#changePlan">changePlan(customerId, subscriptionId, body)</a></code></p>
82<p class="firstline">Changes the plan of a subscription</p>
83<p class="toc_element">
84 <code><a href="#changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</a></code></p>
85<p class="firstline">Changes the renewal settings of a subscription</p>
86<p class="toc_element">
87 <code><a href="#changeSeats">changeSeats(customerId, subscriptionId, body)</a></code></p>
88<p class="firstline">Changes the seats configuration of a subscription</p>
89<p class="toc_element">
90 <code><a href="#delete">delete(customerId, subscriptionId, deletionType)</a></code></p>
91<p class="firstline">Cancels/Downgrades a subscription.</p>
92<p class="toc_element">
93 <code><a href="#get">get(customerId, subscriptionId)</a></code></p>
94<p class="firstline">Gets a subscription of the customer.</p>
95<p class="toc_element">
96 <code><a href="#insert">insert(customerId, body, customerAuthToken=None)</a></code></p>
97<p class="firstline">Creates/Transfers a subscription for the customer.</p>
98<p class="toc_element">
99 <code><a href="#list">list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)</a></code></p>
100<p class="firstline">Lists subscriptions of a reseller, optionally filtered by a customer name prefix.</p>
101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<p class="toc_element">
105 <code><a href="#startPaidService">startPaidService(customerId, subscriptionId)</a></code></p>
106<p class="firstline">Starts paid service of a trial subscription</p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]107<p class="toc_element">
108 <code><a href="#suspend">suspend(customerId, subscriptionId)</a></code></p>
109<p class="firstline">Suspends an active subscription</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]112 <code class="details" id="activate">activate(customerId, subscriptionId)</code>
113 <pre>Activates a subscription previously suspended by the reseller
114
115Args:
116 customerId: string, Id of the Customer (required)
117 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
118
119Returns:
120 An object of the form:
121
122 { # JSON template for a subscription.
123 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
124 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
125 "renewalType": "A String", # Subscription renewal type.
126 },
127 "skuId": "A String", # Name of the sku for which this subscription is purchased.
128 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
129 "trialSettings": { # Trial Settings of the subscription.
130 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
131 "isInTrial": True or False, # Whether the subscription is in trial.
132 },
133 "transferInfo": { # Transfer related information for the subscription.
134 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
135 "minimumTransferableSeats": 42,
136 },
137 "resourceUiUrl": "A String", # Ui url for subscription resource.
138 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
139 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
140 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
141 "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.
142 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
143 },
144 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
145 "status": "A String", # Status of the subscription.
146 "plan": { # Plan details of the subscription
147 "planName": "A String", # The plan name of this subscription's plan.
148 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
149 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
150 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
151 },
152 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
153 },
154 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
155 "subscriptionId": "A String", # The id of the subscription.
156 "customerId": "A String", # The id of the customer to whom the subscription belongs.
157 }</pre>
158</div>
159
160<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 <code class="details" id="changePlan">changePlan(customerId, subscriptionId, body)</code>
162 <pre>Changes the plan of a subscription
163
164Args:
165 customerId: string, Id of the Customer (required)
166 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
167 body: object, The request body. (required)
168 The object takes the form of:
169
170{ # JSON template for the ChangePlan rpc request.
171 "planName": "A String", # Name of the plan to change to.
172 "kind": "subscriptions#changePlanRequest", # Identifies the resource as a subscription change plan request.
173 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
174 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
175 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
176 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]177 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]178 },
179 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
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 },
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.
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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]206 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 },
208 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
209 "status": "A String", # Status of the subscription.
210 "plan": { # Plan details of the subscription
211 "planName": "A String", # The plan name of this subscription's plan.
212 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
213 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
214 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
215 },
216 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
217 },
218 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
219 "subscriptionId": "A String", # The id of the subscription.
220 "customerId": "A String", # The id of the customer to whom the subscription belongs.
221 }</pre>
222</div>
223
224<div class="method">
225 <code class="details" id="changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</code>
226 <pre>Changes the renewal settings of a subscription
227
228Args:
229 customerId: string, Id of the Customer (required)
230 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
231 body: object, The request body. (required)
232 The object takes the form of:
233
234{ # JSON template for a subscription renewal settings.
235 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
236 "renewalType": "A String", # Subscription renewal type.
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 },
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.
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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]263 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]264 },
265 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
266 "status": "A String", # Status of the subscription.
267 "plan": { # Plan details of the subscription
268 "planName": "A String", # The plan name of this subscription's plan.
269 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
270 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
271 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
272 },
273 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
274 },
275 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
276 "subscriptionId": "A String", # The id of the subscription.
277 "customerId": "A String", # The id of the customer to whom the subscription belongs.
278 }</pre>
279</div>
280
281<div class="method">
282 <code class="details" id="changeSeats">changeSeats(customerId, subscriptionId, body)</code>
283 <pre>Changes the seats configuration of a subscription
284
285Args:
286 customerId: string, Id of the Customer (required)
287 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
288 body: object, The request body. (required)
289 The object takes the form of:
290
291{ # JSON template for subscription seats.
292 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
293 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
294 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]295 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]296}
297
298
299Returns:
300 An object of the form:
301
302 { # JSON template for a subscription.
303 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
304 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
305 "renewalType": "A String", # Subscription renewal type.
306 },
307 "skuId": "A String", # Name of the sku for which this subscription is purchased.
308 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
309 "trialSettings": { # Trial Settings of the subscription.
310 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
311 "isInTrial": True or False, # Whether the subscription is in trial.
312 },
313 "transferInfo": { # Transfer related information for the subscription.
314 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
315 "minimumTransferableSeats": 42,
316 },
317 "resourceUiUrl": "A String", # Ui url for subscription resource.
318 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
319 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
320 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
321 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]322 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]323 },
324 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
325 "status": "A String", # Status of the subscription.
326 "plan": { # Plan details of the subscription
327 "planName": "A String", # The plan name of this subscription's plan.
328 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
329 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
330 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
331 },
332 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
333 },
334 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
335 "subscriptionId": "A String", # The id of the subscription.
336 "customerId": "A String", # The id of the customer to whom the subscription belongs.
337 }</pre>
338</div>
339
340<div class="method">
341 <code class="details" id="delete">delete(customerId, subscriptionId, deletionType)</code>
342 <pre>Cancels/Downgrades a subscription.
343
344Args:
345 customerId: string, Id of the Customer (required)
346 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
347 deletionType: string, Whether the subscription is to be fully cancelled or downgraded (required)
348 Allowed values
349 cancel - Cancels the subscription immediately
350 downgrade - Downgrades a Google Apps for Business subscription to Google Apps
351 suspend - Suspends the subscriptions for 4 days before cancelling it
352</pre>
353</div>
354
355<div class="method">
356 <code class="details" id="get">get(customerId, subscriptionId)</code>
357 <pre>Gets a subscription of the customer.
358
359Args:
360 customerId: string, Id of the Customer (required)
361 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
362
363Returns:
364 An object of the form:
365
366 { # JSON template for a subscription.
367 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
368 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
369 "renewalType": "A String", # Subscription renewal type.
370 },
371 "skuId": "A String", # Name of the sku for which this subscription is purchased.
372 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
373 "trialSettings": { # Trial Settings of the subscription.
374 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
375 "isInTrial": True or False, # Whether the subscription is in trial.
376 },
377 "transferInfo": { # Transfer related information for the subscription.
378 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
379 "minimumTransferableSeats": 42,
380 },
381 "resourceUiUrl": "A String", # Ui url for subscription resource.
382 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
383 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
384 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
385 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]386 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]387 },
388 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
389 "status": "A String", # Status of the subscription.
390 "plan": { # Plan details of the subscription
391 "planName": "A String", # The plan name of this subscription's plan.
392 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
393 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
394 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
395 },
396 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
397 },
398 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
399 "subscriptionId": "A String", # The id of the subscription.
400 "customerId": "A String", # The id of the customer to whom the subscription belongs.
401 }</pre>
402</div>
403
404<div class="method">
405 <code class="details" id="insert">insert(customerId, body, customerAuthToken=None)</code>
406 <pre>Creates/Transfers a subscription for the customer.
407
408Args:
409 customerId: string, Id of the Customer (required)
410 body: object, The request body. (required)
411 The object takes the form of:
412
413{ # JSON template for a subscription.
414 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
415 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
416 "renewalType": "A String", # Subscription renewal type.
417 },
418 "skuId": "A String", # Name of the sku for which this subscription is purchased.
419 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
420 "trialSettings": { # Trial Settings of the subscription.
421 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
422 "isInTrial": True or False, # Whether the subscription is in trial.
423 },
424 "transferInfo": { # Transfer related information for the subscription.
425 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
426 "minimumTransferableSeats": 42,
427 },
428 "resourceUiUrl": "A String", # Ui url for subscription resource.
429 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
430 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
431 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
432 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]433 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]434 },
435 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
436 "status": "A String", # Status of the subscription.
437 "plan": { # Plan details of the subscription
438 "planName": "A String", # The plan name of this subscription's plan.
439 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
440 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
441 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
442 },
443 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
444 },
445 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
446 "subscriptionId": "A String", # The id of the subscription.
447 "customerId": "A String", # The id of the customer to whom the subscription belongs.
448 }
449
450 customerAuthToken: string, An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.
451
452Returns:
453 An object of the form:
454
455 { # JSON template for a subscription.
456 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
457 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
458 "renewalType": "A String", # Subscription renewal type.
459 },
460 "skuId": "A String", # Name of the sku for which this subscription is purchased.
461 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
462 "trialSettings": { # Trial Settings of the subscription.
463 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
464 "isInTrial": True or False, # Whether the subscription is in trial.
465 },
466 "transferInfo": { # Transfer related information for the subscription.
467 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
468 "minimumTransferableSeats": 42,
469 },
470 "resourceUiUrl": "A String", # Ui url for subscription resource.
471 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
472 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
473 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
474 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]475 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]476 },
477 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
478 "status": "A String", # Status of the subscription.
479 "plan": { # Plan details of the subscription
480 "planName": "A String", # The plan name of this subscription's plan.
481 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
482 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
483 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
484 },
485 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
486 },
487 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
488 "subscriptionId": "A String", # The id of the subscription.
489 "customerId": "A String", # The id of the customer to whom the subscription belongs.
490 }</pre>
491</div>
492
493<div class="method">
494 <code class="details" id="list">list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)</code>
495 <pre>Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
496
497Args:
498 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.
499 pageToken: string, Token to specify next page in the list
500 maxResults: integer, Maximum number of results to return
501 customerNamePrefix: string, Prefix of the customer's domain name by which the subscriptions should be filtered. Optional
502 customerId: string, Id of the Customer
503
504Returns:
505 An object of the form:
506
507 { # JSON template for a subscription list.
508 "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.
509 "kind": "reseller#subscriptions", # Identifies the resource as a collection of subscriptions.
510 "subscriptions": [ # The subscriptions in this page of results.
511 { # JSON template for a subscription.
512 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
513 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
514 "renewalType": "A String", # Subscription renewal type.
515 },
516 "skuId": "A String", # Name of the sku for which this subscription is purchased.
517 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
518 "trialSettings": { # Trial Settings of the subscription.
519 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
520 "isInTrial": True or False, # Whether the subscription is in trial.
521 },
522 "transferInfo": { # Transfer related information for the subscription.
523 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
524 "minimumTransferableSeats": 42,
525 },
526 "resourceUiUrl": "A String", # Ui url for subscription resource.
527 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
528 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
529 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
530 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]531 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]532 },
533 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
534 "status": "A String", # Status of the subscription.
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 },
547 ],
548 }</pre>
549</div>
550
551<div class="method">
552 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
553 <pre>Retrieves the next page of results.
554
555Args:
556 previous_request: The request for the previous page. (required)
557 previous_response: The response from the request for the previous page. (required)
558
559Returns:
560 A request object that you can call 'execute()' on to request the next
561 page. Returns None if there are no more items in the collection.
562 </pre>
563</div>
564
565<div class="method">
566 <code class="details" id="startPaidService">startPaidService(customerId, subscriptionId)</code>
567 <pre>Starts paid service of a trial subscription
568
569Args:
570 customerId: string, Id of the Customer (required)
571 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
572
573Returns:
574 An object of the form:
575
576 { # JSON template for a subscription.
577 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
578 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
579 "renewalType": "A String", # Subscription renewal type.
580 },
581 "skuId": "A String", # Name of the sku for which this subscription is purchased.
582 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
583 "trialSettings": { # Trial Settings of the subscription.
584 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
585 "isInTrial": True or False, # Whether the subscription is in trial.
586 },
587 "transferInfo": { # Transfer related information for the subscription.
588 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
589 "minimumTransferableSeats": 42,
590 },
591 "resourceUiUrl": "A String", # Ui url for subscription resource.
592 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
593 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
594 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
595 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]596 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
597 },
598 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
599 "status": "A String", # Status of the subscription.
600 "plan": { # Plan details of the subscription
601 "planName": "A String", # The plan name of this subscription's plan.
602 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
603 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
604 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
605 },
606 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
607 },
608 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
609 "subscriptionId": "A String", # The id of the subscription.
610 "customerId": "A String", # The id of the customer to whom the subscription belongs.
611 }</pre>
612</div>
613
614<div class="method">
615 <code class="details" id="suspend">suspend(customerId, subscriptionId)</code>
616 <pre>Suspends an active subscription
617
618Args:
619 customerId: string, Id of the Customer (required)
620 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
621
622Returns:
623 An object of the form:
624
625 { # JSON template for a subscription.
626 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
627 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
628 "renewalType": "A String", # Subscription renewal type.
629 },
630 "skuId": "A String", # Name of the sku for which this subscription is purchased.
631 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
632 "trialSettings": { # Trial Settings of the subscription.
633 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
634 "isInTrial": True or False, # Whether the subscription is in trial.
635 },
636 "transferInfo": { # Transfer related information for the subscription.
637 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
638 "minimumTransferableSeats": 42,
639 },
640 "resourceUiUrl": "A String", # Ui url for subscription resource.
641 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
642 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
643 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
644 "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.
645 "licensedNumberOfSeats": 42, # Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]646 },
647 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
648 "status": "A String", # Status of the subscription.
649 "plan": { # Plan details of the subscription
650 "planName": "A String", # The plan name of this subscription's plan.
651 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
652 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
653 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
654 },
655 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
656 },
657 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
658 "subscriptionId": "A String", # The id of the subscription.
659 "customerId": "A String", # The id of the customer to whom the subscription belongs.
660 }</pre>
661</div>
662
663</body></html>