blob: b20b63cae2a40a5fb920917a8d7aabfa7f502cad [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070075<h1><a href="reseller_v1.html">Workspace Reseller API</a> . <a href="reseller_v1.subscriptions.html">subscriptions</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -070078 <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">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#changePlan">changePlan(customerId, subscriptionId, body=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040082<p class="firstline">Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040085<p class="firstline">Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only.</p>
John Asmuth614db982014-04-24 15:46:26 -040086<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#changeSeats">changeSeats(customerId, subscriptionId, body=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040088<p class="firstline">Update a subscription's user license settings.</p>
John Asmuth614db982014-04-24 15:46:26 -040089<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090 <code><a href="#close">close()</a></code></p>
91<p class="firstline">Close httplib2 connections.</p>
92<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -040093 <code><a href="#delete">delete(customerId, subscriptionId, deletionType)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070094<p class="firstline">Cancel, suspend, or transfer a subscription to direct.</p>
John Asmuth614db982014-04-24 15:46:26 -040095<p class="toc_element">
96 <code><a href="#get">get(customerId, subscriptionId)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040097<p class="firstline">Get a specific subscription.</p>
John Asmuth614db982014-04-24 15:46:26 -040098<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#insert">insert(customerId, body=None, customerAuthToken=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400100<p class="firstline">Create or transfer a subscription.</p>
John Asmuth614db982014-04-24 15:46:26 -0400101<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800102 <code><a href="#list">list(customerAuthToken=None, maxResults=None, pageToken=None, customerId=None, customerNamePrefix=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400103<p class="firstline">List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.</p>
John Asmuth614db982014-04-24 15:46:26 -0400104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#startPaidService">startPaidService(customerId, subscriptionId)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400109<p class="firstline">Immediately move a 30-day free trial subscription to a paid service subscription.</p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700110<p class="toc_element">
111 <code><a href="#suspend">suspend(customerId, subscriptionId)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400112<p class="firstline">Suspends an active subscription.</p>
John Asmuth614db982014-04-24 15:46:26 -0400113<h3>Method Details</h3>
114<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700115 <code class="details" id="activate">activate(customerId, subscriptionId)</code>
116 <pre>Activates a subscription previously suspended by the reseller
117
118Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400120 subscriptionId: string, This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700121
122Returns:
123 An object of the form:
124
125 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800126 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800127 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
128 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
129 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
130 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800131 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800132 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
133 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
134 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
135 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
136 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
137 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
138 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800139 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
140 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
141 # - true — The plan is in trial.
142 # - false — The plan is not in trial.
143 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
144 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800145 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800146 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
147 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
148 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
149 },
150 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800151 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800152 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
153 #
154 # Possible values are:
155 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
156 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
157 # - FLEXIBLE — The flexible plan
158 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
159 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
160 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
161 # - true — The subscription&#x27;s plan is an annual commitment plan.
162 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800163 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
164 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
165 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
166 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800167 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800168 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
169 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
170 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
171 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
172 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
173 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
174 #
175 # Possible options include:
176 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
177 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
178 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
179 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
180 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
181 &quot;A String&quot;,
182 ],
183 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
184 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700185 }</pre>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700186</div>
187
188<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700189 <code class="details" id="changePlan">changePlan(customerId, subscriptionId, body=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400190 <pre>Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.
John Asmuth614db982014-04-24 15:46:26 -0400191
192Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700193 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400194 subscriptionId: string, This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700195 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400196 The object takes the form of:
197
198{ # JSON template for the ChangePlan rpc request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800199 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The seats property is the number of user seat licenses.
200 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
201 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
202 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
203 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
204 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700205 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s payment plan. For more information about the Google payment plans, see API concepts.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400206 #
207 # Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700208 # - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400209 # - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments
210 # - FLEXIBLE - The flexible plan
211 # - TRIAL - The 30-day free trial plan
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800212 &quot;kind&quot;: &quot;subscriptions#changePlanRequest&quot;, # Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800213 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800214 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in changePlan request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply.
John Asmuth614db982014-04-24 15:46:26 -0400215 }
216
217
218Returns:
219 An object of the form:
220
221 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800222 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800223 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
224 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
225 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
226 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800227 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800228 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
229 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
230 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
231 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
232 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
233 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
234 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800235 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
236 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
237 # - true — The plan is in trial.
238 # - false — The plan is not in trial.
239 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
240 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800241 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800242 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
243 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
244 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
245 },
246 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800247 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800248 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
249 #
250 # Possible values are:
251 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
252 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
253 # - FLEXIBLE — The flexible plan
254 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
255 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
256 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
257 # - true — The subscription&#x27;s plan is an annual commitment plan.
258 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800259 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
260 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
261 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
262 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800263 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800264 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
265 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
266 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
267 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
268 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
269 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
270 #
271 # Possible options include:
272 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
273 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
274 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
275 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
276 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
277 &quot;A String&quot;,
278 ],
279 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
280 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700281 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400282</div>
283
284<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700285 <code class="details" id="changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700286 <pre>Update a user license&#x27;s renewal settings. This is applicable for accounts with annual commitment plans only.
John Asmuth614db982014-04-24 15:46:26 -0400287
288Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700289 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400290 subscriptionId: string, This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700291 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400292 The object takes the form of:
293
294{ # JSON template for a subscription renewal settings.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800295 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800296 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
John Asmuth614db982014-04-24 15:46:26 -0400297}
298
299
300Returns:
301 An object of the form:
302
303 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800304 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800305 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
306 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
307 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
308 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800309 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800310 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
311 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
312 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
313 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
314 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
315 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
316 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800317 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
318 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
319 # - true — The plan is in trial.
320 # - false — The plan is not in trial.
321 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
322 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800323 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800324 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
325 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
326 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
327 },
328 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800329 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800330 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
331 #
332 # Possible values are:
333 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
334 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
335 # - FLEXIBLE — The flexible plan
336 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
337 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
338 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
339 # - true — The subscription&#x27;s plan is an annual commitment plan.
340 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800341 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
342 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
343 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
344 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800345 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800346 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
347 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
348 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
349 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
350 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
351 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
352 #
353 # Possible options include:
354 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
355 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
356 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
357 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
358 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
359 &quot;A String&quot;,
360 ],
361 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
362 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700363 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400364</div>
365
366<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700367 <code class="details" id="changeSeats">changeSeats(customerId, subscriptionId, body=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700368 <pre>Update a subscription&#x27;s user license settings.
John Asmuth614db982014-04-24 15:46:26 -0400369
370Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700371 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400372 subscriptionId: string, This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700373 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400374 The object takes the form of:
375
376{ # JSON template for subscription seats.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800377 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800378 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800379 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800380 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
John Asmuth614db982014-04-24 15:46:26 -0400381}
382
383
384Returns:
385 An object of the form:
386
387 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800388 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800389 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
390 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
391 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
392 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800393 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800394 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
395 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
396 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
397 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
398 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
399 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
400 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800401 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
402 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
403 # - true — The plan is in trial.
404 # - false — The plan is not in trial.
405 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
406 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800407 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800408 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
409 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
410 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
411 },
412 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800413 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800414 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
415 #
416 # Possible values are:
417 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
418 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
419 # - FLEXIBLE — The flexible plan
420 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
421 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
422 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
423 # - true — The subscription&#x27;s plan is an annual commitment plan.
424 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800425 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
426 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
427 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
428 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800429 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800430 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
431 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
432 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
433 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
434 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
435 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
436 #
437 # Possible options include:
438 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
439 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
440 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
441 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
442 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
443 &quot;A String&quot;,
444 ],
445 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
446 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700447 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400448</div>
449
450<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700451 <code class="details" id="close">close()</code>
452 <pre>Close httplib2 connections.</pre>
453</div>
454
455<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400456 <code class="details" id="delete">delete(customerId, subscriptionId, deletionType)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700457 <pre>Cancel, suspend, or transfer a subscription to direct.
John Asmuth614db982014-04-24 15:46:26 -0400458
459Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700460 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400461 subscriptionId: string, This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. (required)
462 deletionType: string, The deletionType query string enables the cancellation, downgrade, or suspension of a subscription. (required)
John Asmuth614db982014-04-24 15:46:26 -0400463 Allowed values
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400464 cancel - Cancels the subscription immediately. This does not apply to a G Suite subscription.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700465 transfer_to_direct - Transfers a subscription directly to Google. The customer is immediately transferred to a direct billing relationship with Google and is given a short amount of time with no service interruption. The customer can then choose to set up billing directly with Google by using a credit card, or they can transfer to another reseller.
John Asmuth614db982014-04-24 15:46:26 -0400466</pre>
467</div>
468
469<div class="method">
470 <code class="details" id="get">get(customerId, subscriptionId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400471 <pre>Get a specific subscription.
John Asmuth614db982014-04-24 15:46:26 -0400472
473Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700474 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400475 subscriptionId: string, This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. (required)
John Asmuth614db982014-04-24 15:46:26 -0400476
477Returns:
478 An object of the form:
479
480 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800481 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800482 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
483 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
484 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
485 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800486 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800487 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
488 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
489 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
490 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
491 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
492 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
493 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800494 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
495 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
496 # - true — The plan is in trial.
497 # - false — The plan is not in trial.
498 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
499 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800500 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800501 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
502 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
503 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
504 },
505 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800506 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800507 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
508 #
509 # Possible values are:
510 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
511 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
512 # - FLEXIBLE — The flexible plan
513 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
514 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
515 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
516 # - true — The subscription&#x27;s plan is an annual commitment plan.
517 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800518 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
519 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
520 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
521 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800522 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800523 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
524 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
525 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
526 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
527 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
528 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
529 #
530 # Possible options include:
531 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
532 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
533 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
534 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
535 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
536 &quot;A String&quot;,
537 ],
538 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
539 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700540 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400541</div>
542
543<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700544 <code class="details" id="insert">insert(customerId, body=None, customerAuthToken=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400545 <pre>Create or transfer a subscription.
John Asmuth614db982014-04-24 15:46:26 -0400546
547Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700548 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700549 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400550 The object takes the form of:
551
552{ # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800553 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800554 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
555 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
556 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
557 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800558 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800559 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
560 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
561 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
562 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
563 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
564 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
565 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800566 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
567 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
568 # - true — The plan is in trial.
569 # - false — The plan is not in trial.
570 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
571 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800572 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800573 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
574 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
575 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
576 },
577 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800578 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800579 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
580 #
581 # Possible values are:
582 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
583 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
584 # - FLEXIBLE — The flexible plan
585 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
586 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
587 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
588 # - true — The subscription&#x27;s plan is an annual commitment plan.
589 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800590 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
591 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
592 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
593 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800594 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800595 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
596 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
597 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
598 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
599 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
600 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
601 #
602 # Possible options include:
603 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
604 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
605 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
606 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
607 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
608 &quot;A String&quot;,
609 ],
610 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
611 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700612}
613
614 customerAuthToken: string, The customerAuthToken query string is required when creating a resold account that transfers a direct customer&#x27;s subscription or transfers another reseller customer&#x27;s subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
615
616Returns:
617 An object of the form:
618
619 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800620 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800621 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
622 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
623 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
624 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800625 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800626 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
627 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
628 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
629 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
630 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
631 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
632 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800633 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
634 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
635 # - true — The plan is in trial.
636 # - false — The plan is not in trial.
637 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
638 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800639 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800640 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
641 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
642 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
643 },
644 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800645 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800646 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
647 #
648 # Possible values are:
649 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
650 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
651 # - FLEXIBLE — The flexible plan
652 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
653 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
654 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
655 # - true — The subscription&#x27;s plan is an annual commitment plan.
656 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800657 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
658 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
659 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
660 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800661 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800662 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
663 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
664 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
665 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
666 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
667 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
668 #
669 # Possible options include:
670 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
671 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
672 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
673 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
674 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
675 &quot;A String&quot;,
676 ],
677 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
678 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700679 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400680</div>
681
682<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800683 <code class="details" id="list">list(customerAuthToken=None, maxResults=None, pageToken=None, customerId=None, customerNamePrefix=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700684 <pre>List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer&#x27;s subscriptions, or all of a customer&#x27;s transferable subscriptions.
John Asmuth614db982014-04-24 15:46:26 -0400685
686Args:
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800687 customerAuthToken: string, The customerAuthToken query string is required when creating a resold account that transfers a direct customer&#x27;s subscription or transfers another reseller customer&#x27;s subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
688 maxResults: integer, When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800689 pageToken: string, Token to specify next page in the list
690 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400691 customerNamePrefix: string, When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com:
Bu Sun Kim65020912020-05-20 12:08:20 -0700692- exa -- Returns all customer names that start with &#x27;exa&#x27; which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression&#x27;s asterisk, exa*.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400693- example -- Returns example20.com and example.com.
John Asmuth614db982014-04-24 15:46:26 -0400694
695Returns:
696 An object of the form:
697
698 { # JSON template for a subscription list.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800699 &quot;kind&quot;: &quot;reseller#subscriptions&quot;, # Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions
700 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700701 &quot;subscriptions&quot;: [ # The subscriptions in this page of results.
John Asmuth614db982014-04-24 15:46:26 -0400702 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800703 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800704 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
705 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
706 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
707 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800708 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800709 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
710 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
711 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
712 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
713 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
714 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
715 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800716 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
717 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
718 # - true — The plan is in trial.
719 # - false — The plan is not in trial.
720 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
721 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800722 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800723 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
724 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
725 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
726 },
727 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800728 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800729 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
730 #
731 # Possible values are:
732 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
733 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
734 # - FLEXIBLE — The flexible plan
735 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
736 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
737 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
738 # - true — The subscription&#x27;s plan is an annual commitment plan.
739 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800740 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
741 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
742 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
743 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800744 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800745 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
746 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
747 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
748 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
749 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
750 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
751 #
752 # Possible options include:
753 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
754 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
755 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
756 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
757 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
758 &quot;A String&quot;,
759 ],
760 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
761 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700762 },
John Asmuth614db982014-04-24 15:46:26 -0400763 ],
764 }</pre>
765</div>
766
767<div class="method">
768 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
769 <pre>Retrieves the next page of results.
770
771Args:
772 previous_request: The request for the previous page. (required)
773 previous_response: The response from the request for the previous page. (required)
774
775Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700776 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400777 page. Returns None if there are no more items in the collection.
778 </pre>
779</div>
780
781<div class="method">
782 <code class="details" id="startPaidService">startPaidService(customerId, subscriptionId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400783 <pre>Immediately move a 30-day free trial subscription to a paid service subscription.
John Asmuth614db982014-04-24 15:46:26 -0400784
785Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700786 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400787 subscriptionId: string, This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. (required)
John Asmuth614db982014-04-24 15:46:26 -0400788
789Returns:
790 An object of the form:
791
792 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800793 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800794 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
795 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
796 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
797 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800798 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800799 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
800 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
801 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
802 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
803 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
804 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
805 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800806 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
807 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
808 # - true — The plan is in trial.
809 # - false — The plan is not in trial.
810 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
811 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800812 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800813 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
814 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
815 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
816 },
817 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800818 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800819 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
820 #
821 # Possible values are:
822 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
823 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
824 # - FLEXIBLE — The flexible plan
825 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
826 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
827 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
828 # - true — The subscription&#x27;s plan is an annual commitment plan.
829 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800830 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
831 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
832 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
833 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800834 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800835 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
836 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
837 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
838 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
839 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
840 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
841 #
842 # Possible options include:
843 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
844 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
845 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
846 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
847 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
848 &quot;A String&quot;,
849 ],
850 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
851 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700852 }</pre>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700853</div>
854
855<div class="method">
856 <code class="details" id="suspend">suspend(customerId, subscriptionId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400857 <pre>Suspends an active subscription.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700858
859Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700860 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;s unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400861 subscriptionId: string, This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700862
863Returns:
864 An object of the form:
865
866 { # JSON template for a subscription.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800867 &quot;skuId&quot;: &quot;A String&quot;, # A required property. The skuId is a unique system identifier for a product&#x27;s SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800868 &quot;transferInfo&quot;: { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
869 &quot;minimumTransferableSeats&quot;: 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
870 &quot;transferabilityExpirationTime&quot;: &quot;A String&quot;, # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
871 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800872 &quot;subscriptionId&quot;: &quot;A String&quot;, # The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800873 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;s Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
874 &quot;seats&quot;: { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
875 &quot;licensedNumberOfSeats&quot;: 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field&#x27;s value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
876 &quot;maximumNumberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller&#x27;s contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
877 &quot;kind&quot;: &quot;subscriptions#seats&quot;, # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
878 &quot;numberOfSeats&quot;: 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
879 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800880 &quot;trialSettings&quot;: { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
881 &quot;isInTrial&quot;: True or False, # Determines if a subscription&#x27;s plan is in a 30-day free trial or not:
882 # - true — The plan is in trial.
883 # - false — The plan is not in trial.
884 &quot;trialEndTime&quot;: &quot;A String&quot;, # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
885 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800886 &quot;billingMethod&quot;: &quot;A String&quot;, # Read-only field that returns the current billing method for a subscription.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800887 &quot;renewalSettings&quot;: { # JSON template for a subscription renewal settings. # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
888 &quot;kind&quot;: &quot;subscriptions#renewalSettings&quot;, # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
889 &quot;renewalType&quot;: &quot;A String&quot;, # Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.
890 },
891 &quot;skuName&quot;: &quot;A String&quot;, # Read-only external display name for a product&#x27;s SKU assigned to a customer in the subscription. SKU names are subject to change at Google&#x27;s discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800892 &quot;plan&quot;: { # The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API&quot;s payment plans, see the API concepts.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800893 &quot;planName&quot;: &quot;A String&quot;, # The planName property is required. This is the name of the subscription&#x27;s plan. For more information about the Google payment plans, see the API concepts.
894 #
895 # Possible values are:
896 # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
897 # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
898 # - FLEXIBLE — The flexible plan
899 # - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
900 # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
901 &quot;isCommitmentPlan&quot;: True or False, # The isCommitmentPlan property&#x27;s boolean value identifies the plan as an annual commitment plan:
902 # - true — The subscription&#x27;s plan is an annual commitment plan.
903 # - false — The plan is not an annual commitment plan.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800904 &quot;commitmentInterval&quot;: { # In this version of the API, annual commitment plan&#x27;s interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
905 &quot;startTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
906 &quot;endTime&quot;: &quot;A String&quot;, # An annual commitment plan&#x27;s interval&#x27;s endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
907 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800908 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800909 &quot;creationTime&quot;: &quot;A String&quot;, # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
910 &quot;dealCode&quot;: &quot;A String&quot;, # Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
911 &quot;kind&quot;: &quot;reseller#subscription&quot;, # Identifies the resource as a Subscription. Value: reseller#subscription
912 &quot;status&quot;: &quot;A String&quot;, # This is an optional property.
913 &quot;customerDomain&quot;: &quot;A String&quot;, # Primary domain name of the customer
914 &quot;suspensionReasons&quot;: [ # 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&#x27;s STATUS is SUSPENDED until all pending suspensions are removed.
915 #
916 # Possible options include:
917 # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
918 # - RENEWAL_WITH_TYPE_CANCEL - The customer&#x27;s commitment ended and their service was cancelled at the end of their term.
919 # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
920 # - TRIAL_ENDED - The customer&#x27;s trial expired without a plan selected.
921 # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
922 &quot;A String&quot;,
923 ],
924 &quot;purchaseOrderId&quot;: &quot;A String&quot;, # This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
925 &quot;customerId&quot;: &quot;A String&quot;, # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
Bu Sun Kim65020912020-05-20 12:08:20 -0700926 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400927</div>
928
929</body></html>