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