Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / reseller_v1.subscriptions.html
blob: a5bb7ff4faaecbde1e27fc7032754b350cbc228c [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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]142 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]156 "billingMethod": "A String", # Billing method of this subscription.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]157 "customerId": "A String", # The id of the customer to whom the subscription belongs.
158 }</pre>
159</div>
160
161<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 <code class="details" id="changePlan">changePlan(customerId, subscriptionId, body)</code>
163 <pre>Changes the plan of a subscription
164
165Args:
166 customerId: string, Id of the Customer (required)
167 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
168 body: object, The request body. (required)
169 The object takes the form of:
170
171{ # JSON template for the ChangePlan rpc request.
172 "planName": "A String", # Name of the plan to change to.
173 "kind": "subscriptions#changePlanRequest", # Identifies the resource as a subscription change plan request.
174 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
175 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
176 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
177 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]178 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]179 },
180 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
181 }
182
183
184Returns:
185 An object of the form:
186
187 { # JSON template for a subscription.
188 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
189 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
190 "renewalType": "A String", # Subscription renewal type.
191 },
192 "skuId": "A String", # Name of the sku for which this subscription is purchased.
193 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
194 "trialSettings": { # Trial Settings of the subscription.
195 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
196 "isInTrial": True or False, # Whether the subscription is in trial.
197 },
198 "transferInfo": { # Transfer related information for the subscription.
199 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
200 "minimumTransferableSeats": 42,
201 },
202 "resourceUiUrl": "A String", # Ui url for subscription resource.
203 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
204 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
205 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
206 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]207 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 },
209 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
210 "status": "A String", # Status of the subscription.
211 "plan": { # Plan details of the subscription
212 "planName": "A String", # The plan name of this subscription's plan.
213 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
214 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
215 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
216 },
217 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
218 },
219 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
220 "subscriptionId": "A String", # The id of the subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]221 "billingMethod": "A String", # Billing method of this subscription.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 "customerId": "A String", # The id of the customer to whom the subscription belongs.
223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</code>
228 <pre>Changes the renewal settings of a subscription
229
230Args:
231 customerId: string, Id of the Customer (required)
232 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
233 body: object, The request body. (required)
234 The object takes the form of:
235
236{ # JSON template for a subscription renewal settings.
237 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
238 "renewalType": "A String", # Subscription renewal type.
239}
240
241
242Returns:
243 An object of the form:
244
245 { # JSON template for a subscription.
246 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
247 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
248 "renewalType": "A String", # Subscription renewal type.
249 },
250 "skuId": "A String", # Name of the sku for which this subscription is purchased.
251 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
252 "trialSettings": { # Trial Settings of the subscription.
253 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
254 "isInTrial": True or False, # Whether the subscription is in trial.
255 },
256 "transferInfo": { # Transfer related information for the subscription.
257 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
258 "minimumTransferableSeats": 42,
259 },
260 "resourceUiUrl": "A String", # Ui url for subscription resource.
261 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
262 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
263 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
264 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]265 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]266 },
267 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
268 "status": "A String", # Status of the subscription.
269 "plan": { # Plan details of the subscription
270 "planName": "A String", # The plan name of this subscription's plan.
271 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
272 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
273 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
274 },
275 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
276 },
277 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
278 "subscriptionId": "A String", # The id of the subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]279 "billingMethod": "A String", # Billing method of this subscription.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280 "customerId": "A String", # The id of the customer to whom the subscription belongs.
281 }</pre>
282</div>
283
284<div class="method">
285 <code class="details" id="changeSeats">changeSeats(customerId, subscriptionId, body)</code>
286 <pre>Changes the seats configuration of a subscription
287
288Args:
289 customerId: string, Id of the Customer (required)
290 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
291 body: object, The request body. (required)
292 The object takes the form of:
293
294{ # JSON template for subscription seats.
295 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
296 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
297 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]298 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]299}
300
301
302Returns:
303 An object of the form:
304
305 { # JSON template for a subscription.
306 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
307 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
308 "renewalType": "A String", # Subscription renewal type.
309 },
310 "skuId": "A String", # Name of the sku for which this subscription is purchased.
311 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
312 "trialSettings": { # Trial Settings of the subscription.
313 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
314 "isInTrial": True or False, # Whether the subscription is in trial.
315 },
316 "transferInfo": { # Transfer related information for the subscription.
317 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
318 "minimumTransferableSeats": 42,
319 },
320 "resourceUiUrl": "A String", # Ui url for subscription resource.
321 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
322 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
323 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
324 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]325 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]326 },
327 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
328 "status": "A String", # Status of the subscription.
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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]339 "billingMethod": "A String", # Billing method of this subscription.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]340 "customerId": "A String", # The id of the customer to whom the subscription belongs.
341 }</pre>
342</div>
343
344<div class="method">
345 <code class="details" id="delete">delete(customerId, subscriptionId, deletionType)</code>
346 <pre>Cancels/Downgrades a subscription.
347
348Args:
349 customerId: string, Id of the Customer (required)
350 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
351 deletionType: string, Whether the subscription is to be fully cancelled or downgraded (required)
352 Allowed values
353 cancel - Cancels the subscription immediately
354 downgrade - Downgrades a Google Apps for Business subscription to Google Apps
355 suspend - Suspends the subscriptions for 4 days before cancelling it
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]356 transfer_to_direct - Transfers a subscription directly to Google
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]357</pre>
358</div>
359
360<div class="method">
361 <code class="details" id="get">get(customerId, subscriptionId)</code>
362 <pre>Gets a subscription of the customer.
363
364Args:
365 customerId: string, Id of the Customer (required)
366 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
367
368Returns:
369 An object of the form:
370
371 { # JSON template for a subscription.
372 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
373 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
374 "renewalType": "A String", # Subscription renewal type.
375 },
376 "skuId": "A String", # Name of the sku for which this subscription is purchased.
377 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
378 "trialSettings": { # Trial Settings of the subscription.
379 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
380 "isInTrial": True or False, # Whether the subscription is in trial.
381 },
382 "transferInfo": { # Transfer related information for the subscription.
383 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
384 "minimumTransferableSeats": 42,
385 },
386 "resourceUiUrl": "A String", # Ui url for subscription resource.
387 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
388 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
389 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
390 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]391 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]392 },
393 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
394 "status": "A String", # Status of the subscription.
395 "plan": { # Plan details of the subscription
396 "planName": "A String", # The plan name of this subscription's plan.
397 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
398 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
399 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
400 },
401 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
402 },
403 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
404 "subscriptionId": "A String", # The id of the subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]405 "billingMethod": "A String", # Billing method of this subscription.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]406 "customerId": "A String", # The id of the customer to whom the subscription belongs.
407 }</pre>
408</div>
409
410<div class="method">
411 <code class="details" id="insert">insert(customerId, body, customerAuthToken=None)</code>
412 <pre>Creates/Transfers a subscription for the customer.
413
414Args:
415 customerId: string, Id of the Customer (required)
416 body: object, The request body. (required)
417 The object takes the form of:
418
419{ # JSON template for a subscription.
420 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
421 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
422 "renewalType": "A String", # Subscription renewal type.
423 },
424 "skuId": "A String", # Name of the sku for which this subscription is purchased.
425 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
426 "trialSettings": { # Trial Settings of the subscription.
427 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
428 "isInTrial": True or False, # Whether the subscription is in trial.
429 },
430 "transferInfo": { # Transfer related information for the subscription.
431 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
432 "minimumTransferableSeats": 42,
433 },
434 "resourceUiUrl": "A String", # Ui url for subscription resource.
435 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
436 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
437 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
438 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]439 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]440 },
441 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
442 "status": "A String", # Status of the subscription.
443 "plan": { # Plan details of the subscription
444 "planName": "A String", # The plan name of this subscription's plan.
445 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
446 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
447 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
448 },
449 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
450 },
451 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
452 "subscriptionId": "A String", # The id of the subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]453 "billingMethod": "A String", # Billing method of this subscription.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]454 "customerId": "A String", # The id of the customer to whom the subscription belongs.
455 }
456
457 customerAuthToken: string, An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.
458
459Returns:
460 An object of the form:
461
462 { # JSON template for a subscription.
463 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
464 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
465 "renewalType": "A String", # Subscription renewal type.
466 },
467 "skuId": "A String", # Name of the sku for which this subscription is purchased.
468 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
469 "trialSettings": { # Trial Settings of the subscription.
470 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
471 "isInTrial": True or False, # Whether the subscription is in trial.
472 },
473 "transferInfo": { # Transfer related information for the subscription.
474 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
475 "minimumTransferableSeats": 42,
476 },
477 "resourceUiUrl": "A String", # Ui url for subscription resource.
478 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
479 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
480 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
481 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]482 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]483 },
484 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
485 "status": "A String", # Status of the subscription.
486 "plan": { # Plan details of the subscription
487 "planName": "A String", # The plan name of this subscription's plan.
488 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
489 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
490 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
491 },
492 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
493 },
494 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
495 "subscriptionId": "A String", # The id of the subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]496 "billingMethod": "A String", # Billing method of this subscription.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]497 "customerId": "A String", # The id of the customer to whom the subscription belongs.
498 }</pre>
499</div>
500
501<div class="method">
502 <code class="details" id="list">list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)</code>
503 <pre>Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
504
505Args:
506 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.
507 pageToken: string, Token to specify next page in the list
508 maxResults: integer, Maximum number of results to return
509 customerNamePrefix: string, Prefix of the customer's domain name by which the subscriptions should be filtered. Optional
510 customerId: string, Id of the Customer
511
512Returns:
513 An object of the form:
514
515 { # JSON template for a subscription list.
516 "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.
517 "kind": "reseller#subscriptions", # Identifies the resource as a collection of subscriptions.
518 "subscriptions": [ # The subscriptions in this page of results.
519 { # JSON template for a subscription.
520 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
521 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
522 "renewalType": "A String", # Subscription renewal type.
523 },
524 "skuId": "A String", # Name of the sku for which this subscription is purchased.
525 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
526 "trialSettings": { # Trial Settings of the subscription.
527 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
528 "isInTrial": True or False, # Whether the subscription is in trial.
529 },
530 "transferInfo": { # Transfer related information for the subscription.
531 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
532 "minimumTransferableSeats": 42,
533 },
534 "resourceUiUrl": "A String", # Ui url for subscription resource.
535 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
536 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
537 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
538 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]539 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]540 },
541 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
542 "status": "A String", # Status of the subscription.
543 "plan": { # Plan details of the subscription
544 "planName": "A String", # The plan name of this subscription's plan.
545 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
546 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
547 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
548 },
549 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
550 },
551 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
552 "subscriptionId": "A String", # The id of the subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]553 "billingMethod": "A String", # Billing method of this subscription.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]554 "customerId": "A String", # The id of the customer to whom the subscription belongs.
555 },
556 ],
557 }</pre>
558</div>
559
560<div class="method">
561 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
562 <pre>Retrieves the next page of results.
563
564Args:
565 previous_request: The request for the previous page. (required)
566 previous_response: The response from the request for the previous page. (required)
567
568Returns:
569 A request object that you can call 'execute()' on to request the next
570 page. Returns None if there are no more items in the collection.
571 </pre>
572</div>
573
574<div class="method">
575 <code class="details" id="startPaidService">startPaidService(customerId, subscriptionId)</code>
576 <pre>Starts paid service of a trial subscription
577
578Args:
579 customerId: string, Id of the Customer (required)
580 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
581
582Returns:
583 An object of the form:
584
585 { # JSON template for a subscription.
586 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
587 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
588 "renewalType": "A String", # Subscription renewal type.
589 },
590 "skuId": "A String", # Name of the sku for which this subscription is purchased.
591 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
592 "trialSettings": { # Trial Settings of the subscription.
593 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
594 "isInTrial": True or False, # Whether the subscription is in trial.
595 },
596 "transferInfo": { # Transfer related information for the subscription.
597 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
598 "minimumTransferableSeats": 42,
599 },
600 "resourceUiUrl": "A String", # Ui url for subscription resource.
601 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
602 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
603 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
604 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]605 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]606 },
607 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
608 "status": "A String", # Status of the subscription.
609 "plan": { # Plan details of the subscription
610 "planName": "A String", # The plan name of this subscription's plan.
611 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
612 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
613 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
614 },
615 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
616 },
617 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
618 "subscriptionId": "A String", # The id of the subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]619 "billingMethod": "A String", # Billing method of this subscription.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]620 "customerId": "A String", # The id of the customer to whom the subscription belongs.
621 }</pre>
622</div>
623
624<div class="method">
625 <code class="details" id="suspend">suspend(customerId, subscriptionId)</code>
626 <pre>Suspends an active subscription
627
628Args:
629 customerId: string, Id of the Customer (required)
630 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
631
632Returns:
633 An object of the form:
634
635 { # JSON template for a subscription.
636 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
637 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
638 "renewalType": "A String", # Subscription renewal type.
639 },
640 "skuId": "A String", # Name of the sku for which this subscription is purchased.
641 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
642 "trialSettings": { # Trial Settings of the subscription.
643 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
644 "isInTrial": True or False, # Whether the subscription is in trial.
645 },
646 "transferInfo": { # Transfer related information for the subscription.
647 "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
648 "minimumTransferableSeats": 42,
649 },
650 "resourceUiUrl": "A String", # Ui url for subscription resource.
651 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
652 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
653 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
654 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]655 "licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]656 },
657 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
658 "status": "A String", # Status of the subscription.
659 "plan": { # Plan details of the subscription
660 "planName": "A String", # The plan name of this subscription's plan.
661 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
662 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
663 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
664 },
665 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
666 },
667 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
668 "subscriptionId": "A String", # The id of the subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]669 "billingMethod": "A String", # Billing method of this subscription.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]670 "customerId": "A String", # The id of the customer to whom the subscription belongs.
671 }</pre>
672</div>
673
674</body></html>