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