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