blob: bf3a9fa43fdf3a58249ac56dec4453fb9a7d69a1 [file] [log] [blame]
Joe Gregoriod67010d2012-11-05 08:57:06 -05001<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">
78 <code><a href="#changePlan">changePlan(customerId, subscriptionId, body)</a></code></p>
79<p class="firstline">Changes the plan of a subscription</p>
80<p class="toc_element">
81 <code><a href="#changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</a></code></p>
82<p class="firstline">Changes the renewal settings of a subscription</p>
83<p class="toc_element">
84 <code><a href="#changeSeats">changeSeats(customerId, subscriptionId, body)</a></code></p>
85<p class="firstline">Changes the seats configuration of a subscription</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(customerId, subscriptionId, deletionType)</a></code></p>
88<p class="firstline">Cancels/Downgrades a subscription.</p>
89<p class="toc_element">
90 <code><a href="#get">get(customerId, subscriptionId)</a></code></p>
91<p class="firstline">Gets a subscription of the customer.</p>
92<p class="toc_element">
93 <code><a href="#insert">insert(customerId, body, customerAuthToken=None)</a></code></p>
94<p class="firstline">Creates/Transfers a subscription for the customer.</p>
95<p class="toc_element">
96 <code><a href="#list">list(pageToken=None, maxResults=None, customerNamePrefix=None)</a></code></p>
97<p class="firstline">Lists subscriptions of a reseller, optionally filtered by a customer name prefix.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#startPaidService">startPaidService(customerId, subscriptionId)</a></code></p>
103<p class="firstline">Starts paid service of a trial subscription</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="changePlan">changePlan(customerId, subscriptionId, body)</code>
107 <pre>Changes the plan of a subscription
108
109Args:
110 customerId: string, Id of the Customer (required)
111 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
112 body: object, The request body. (required)
113 The object takes the form of:
114
115{ # JSON template for the ChangePlan rpc request.
116 "planName": "A String", # Name of the plan to change to.
117 "kind": "subscriptions#changePlanRequest", # Identifies the resource as a subscription change plan request.
118 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
119 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
120 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
121 "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.
122 },
123 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
124 }
125
126
127Returns:
128 An object of the form:
129
130 { # JSON template for a subscription.
131 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
132 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
133 "renewalType": "A String", # Subscription renewal type.
134 },
135 "skuId": "A String", # Name of the sku for which this subscription is purchased.
136 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
137 "trialSettings": { # Trial Settings of the subscription.
138 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
139 "isInTrial": True or False, # Whether the subscription is in trial.
140 },
141 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
142 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
143 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
144 "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.
145 },
146 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
147 "plan": { # Plan details of the subscription
148 "planName": "A String", # The plan name of this subscription's plan.
149 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
150 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
151 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
152 },
153 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
154 },
155 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
156 "subscriptionId": "A String", # The id of the subscription.
157 "customerId": "A String", # The id of the customer to whom the subscription belongs.
158 }</pre>
159</div>
160
161<div class="method">
162 <code class="details" id="changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</code>
163 <pre>Changes the renewal settings of a subscription
164
165Args:
166 customerId: string, Id of the Customer (required)
167 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
168 body: object, The request body. (required)
169 The object takes the form of:
170
171{ # JSON template for a subscription renewal settings.
172 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
173 "renewalType": "A String", # Subscription renewal type.
174}
175
176
177Returns:
178 An object of the form:
179
180 { # JSON template for a subscription.
181 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
182 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
183 "renewalType": "A String", # Subscription renewal type.
184 },
185 "skuId": "A String", # Name of the sku for which this subscription is purchased.
186 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
187 "trialSettings": { # Trial Settings of the subscription.
188 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
189 "isInTrial": True or False, # Whether the subscription is in trial.
190 },
191 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
192 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
193 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
194 "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.
195 },
196 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
197 "plan": { # Plan details of the subscription
198 "planName": "A String", # The plan name of this subscription's plan.
199 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
200 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
201 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
202 },
203 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
204 },
205 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
206 "subscriptionId": "A String", # The id of the subscription.
207 "customerId": "A String", # The id of the customer to whom the subscription belongs.
208 }</pre>
209</div>
210
211<div class="method">
212 <code class="details" id="changeSeats">changeSeats(customerId, subscriptionId, body)</code>
213 <pre>Changes the seats configuration of a subscription
214
215Args:
216 customerId: string, Id of the Customer (required)
217 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
218 body: object, The request body. (required)
219 The object takes the form of:
220
221{ # JSON template for subscription seats.
222 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
223 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
224 "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.
225}
226
227
228Returns:
229 An object of the form:
230
231 { # JSON template for a subscription.
232 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
233 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
234 "renewalType": "A String", # Subscription renewal type.
235 },
236 "skuId": "A String", # Name of the sku for which this subscription is purchased.
237 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
238 "trialSettings": { # Trial Settings of the subscription.
239 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
240 "isInTrial": True or False, # Whether the subscription is in trial.
241 },
242 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
243 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
244 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
245 "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.
246 },
247 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
248 "plan": { # Plan details of the subscription
249 "planName": "A String", # The plan name of this subscription's plan.
250 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
251 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
252 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
253 },
254 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
255 },
256 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
257 "subscriptionId": "A String", # The id of the subscription.
258 "customerId": "A String", # The id of the customer to whom the subscription belongs.
259 }</pre>
260</div>
261
262<div class="method">
263 <code class="details" id="delete">delete(customerId, subscriptionId, deletionType)</code>
264 <pre>Cancels/Downgrades a subscription.
265
266Args:
267 customerId: string, Id of the Customer (required)
268 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
269 deletionType: string, Whether the subscription is to be fully cancelled or downgraded (required)
270 Allowed values
271 cancel - Cancels the subscription immediately
272 downgrade - Downgrades a Google Apps for Business subscription to Google Apps
273 suspend - Suspends the subscriptions for 4 days before cancelling it
274</pre>
275</div>
276
277<div class="method">
278 <code class="details" id="get">get(customerId, subscriptionId)</code>
279 <pre>Gets a subscription of the customer.
280
281Args:
282 customerId: string, Id of the Customer (required)
283 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
284
285Returns:
286 An object of the form:
287
288 { # JSON template for a subscription.
289 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
290 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
291 "renewalType": "A String", # Subscription renewal type.
292 },
293 "skuId": "A String", # Name of the sku for which this subscription is purchased.
294 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
295 "trialSettings": { # Trial Settings of the subscription.
296 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
297 "isInTrial": True or False, # Whether the subscription is in trial.
298 },
299 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
300 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
301 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
302 "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.
303 },
304 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
305 "plan": { # Plan details of the subscription
306 "planName": "A String", # The plan name of this subscription's plan.
307 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
308 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
309 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
310 },
311 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
312 },
313 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
314 "subscriptionId": "A String", # The id of the subscription.
315 "customerId": "A String", # The id of the customer to whom the subscription belongs.
316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="insert">insert(customerId, body, customerAuthToken=None)</code>
321 <pre>Creates/Transfers a subscription for the customer.
322
323Args:
324 customerId: string, Id of the Customer (required)
325 body: object, The request body. (required)
326 The object takes the form of:
327
328{ # JSON template for a subscription.
329 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
330 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
331 "renewalType": "A String", # Subscription renewal type.
332 },
333 "skuId": "A String", # Name of the sku for which this subscription is purchased.
334 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
335 "trialSettings": { # Trial Settings of the subscription.
336 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
337 "isInTrial": True or False, # Whether the subscription is in trial.
338 },
339 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
340 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
341 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
342 "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.
343 },
344 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
345 "plan": { # Plan details of the subscription
346 "planName": "A String", # The plan name of this subscription's plan.
347 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
348 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
349 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
350 },
351 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
352 },
353 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
354 "subscriptionId": "A String", # The id of the subscription.
355 "customerId": "A String", # The id of the customer to whom the subscription belongs.
356 }
357
358 customerAuthToken: string, An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.
359
360Returns:
361 An object of the form:
362
363 { # JSON template for a subscription.
364 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
365 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
366 "renewalType": "A String", # Subscription renewal type.
367 },
368 "skuId": "A String", # Name of the sku for which this subscription is purchased.
369 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
370 "trialSettings": { # Trial Settings of the subscription.
371 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
372 "isInTrial": True or False, # Whether the subscription is in trial.
373 },
374 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
375 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
376 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
377 "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.
378 },
379 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
380 "plan": { # Plan details of the subscription
381 "planName": "A String", # The plan name of this subscription's plan.
382 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
383 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
384 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
385 },
386 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
387 },
388 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
389 "subscriptionId": "A String", # The id of the subscription.
390 "customerId": "A String", # The id of the customer to whom the subscription belongs.
391 }</pre>
392</div>
393
394<div class="method">
395 <code class="details" id="list">list(pageToken=None, maxResults=None, customerNamePrefix=None)</code>
396 <pre>Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
397
398Args:
399 pageToken: string, Token to specify next page in the list
400 maxResults: integer, Maximum number of results to return
401 customerNamePrefix: string, Prefix of the customer's domain name by which the subscriptions should be filtered. Optional
402
403Returns:
404 An object of the form:
405
406 { # JSON template for a subscription list.
407 "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.
408 "kind": "reseller#subscriptions", # Identifies the resource as a collection of subscriptions.
409 "subscriptions": [ # The subscriptions in this page of results.
410 { # JSON template for a subscription.
411 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
412 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
413 "renewalType": "A String", # Subscription renewal type.
414 },
415 "skuId": "A String", # Name of the sku for which this subscription is purchased.
416 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
417 "trialSettings": { # Trial Settings of the subscription.
418 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
419 "isInTrial": True or False, # Whether the subscription is in trial.
420 },
421 "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
422 "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
423 "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
424 "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.
425 },
426 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
427 "plan": { # Plan details of the subscription
428 "planName": "A String", # The plan name of this subscription's plan.
429 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
430 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
431 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
432 },
433 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
434 },
435 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
436 "subscriptionId": "A String", # The id of the subscription.
437 "customerId": "A String", # The id of the customer to whom the subscription belongs.
438 },
439 ],
440 }</pre>
441</div>
442
443<div class="method">
444 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
445 <pre>Retrieves the next page of results.
446
447Args:
448 previous_request: The request for the previous page. (required)
449 previous_response: The response from the request for the previous page. (required)
450
451Returns:
452 A request object that you can call 'execute()' on to request the next
453 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500454 </pre>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500455</div>
456
457<div class="method">
458 <code class="details" id="startPaidService">startPaidService(customerId, subscriptionId)</code>
459 <pre>Starts paid service of a trial subscription
460
461Args:
462 customerId: string, Id of the Customer (required)
463 subscriptionId: string, Id of the subscription, which is unique for a customer (required)
464
465Returns:
466 An object of the form:
467
468 { # JSON template for a subscription.
469 "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
470 "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
471 "renewalType": "A String", # Subscription renewal type.
472 },
473 "skuId": "A String", # Name of the sku for which this subscription is purchased.
474 "kind": "reseller#subscription", # Identifies the resource as a Subscription.
475 "trialSettings": { # Trial Settings of the subscription.
476 "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
477 "isInTrial": True or False, # Whether the subscription is in trial.
478 },
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.
483 },
484 "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
485 "plan": { # Plan details of the subscription
486 "planName": "A String", # The plan name of this subscription's plan.
487 "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
488 "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
489 "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
490 },
491 "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
492 },
493 "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
494 "subscriptionId": "A String", # The id of the subscription.
495 "customerId": "A String", # The id of the customer to whom the subscription belongs.
496 }</pre>
497</div>
498
499</body></html>