Regen docs (#364)
diff --git a/docs/dyn/reseller_v1.subscriptions.html b/docs/dyn/reseller_v1.subscriptions.html
index c95ca0a..40332da 100644
--- a/docs/dyn/reseller_v1.subscriptions.html
+++ b/docs/dyn/reseller_v1.subscriptions.html
@@ -79,116 +79,146 @@
<p class="firstline">Activates a subscription previously suspended by the reseller</p>
<p class="toc_element">
<code><a href="#changePlan">changePlan(customerId, subscriptionId, body)</a></code></p>
-<p class="firstline">Changes the plan of a subscription</p>
+<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>
<p class="toc_element">
<code><a href="#changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</a></code></p>
-<p class="firstline">Changes the renewal settings of a subscription</p>
+<p class="firstline">Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only.</p>
<p class="toc_element">
<code><a href="#changeSeats">changeSeats(customerId, subscriptionId, body)</a></code></p>
-<p class="firstline">Changes the seats configuration of a subscription</p>
+<p class="firstline">Update a subscription's user license settings.</p>
<p class="toc_element">
<code><a href="#delete">delete(customerId, subscriptionId, deletionType)</a></code></p>
-<p class="firstline">Cancels/Downgrades a subscription.</p>
+<p class="firstline">Cancel, suspend or transfer a subscription to direct.</p>
<p class="toc_element">
<code><a href="#get">get(customerId, subscriptionId)</a></code></p>
-<p class="firstline">Gets a subscription of the customer.</p>
+<p class="firstline">Get a specific subscription.</p>
<p class="toc_element">
<code><a href="#insert">insert(customerId, body, customerAuthToken=None)</a></code></p>
-<p class="firstline">Creates/Transfers a subscription for the customer.</p>
+<p class="firstline">Create or transfer a subscription.</p>
<p class="toc_element">
<code><a href="#list">list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)</a></code></p>
-<p class="firstline">Lists subscriptions of a reseller, optionally filtered by a customer name prefix.</p>
+<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>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#startPaidService">startPaidService(customerId, subscriptionId)</a></code></p>
-<p class="firstline">Starts paid service of a trial subscription</p>
+<p class="firstline">Immediately move a 30-day free trial subscription to a paid service subscription.</p>
<p class="toc_element">
<code><a href="#suspend">suspend(customerId, subscriptionId)</a></code></p>
-<p class="firstline">Suspends an active subscription</p>
+<p class="firstline">Suspends an active subscription.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="activate">activate(customerId, subscriptionId)</code>
<pre>Activates a subscription previously suspended by the reseller
Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
+ 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)
Returns:
An object of the form:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="changePlan">changePlan(customerId, subscriptionId, body)</code>
- <pre>Changes the plan of a subscription
+ <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.
Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
+ 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)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for the ChangePlan rpc request.
- "planName": "A String", # Name of the plan to change to.
- "dealCode": "A String", # External name of the deal code applicable for the subscription. This field is optional. If missing, the deal price plan won't be used.
- "kind": "subscriptions#changePlanRequest", # Identifies the resource as a subscription change plan request.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments
+ # - FLEXIBLE - The flexible plan
+ # - TRIAL - The 30-day free trial plan
+ "dealCode": "A String", # 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.
+ "kind": "subscriptions#changePlanRequest", # Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest
+ "seats": { # JSON template for subscription seats. # This is a required property. The seats property is the number of user seat licenses.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
+ "purchaseOrderId": "A String", # 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.
}
@@ -196,67 +226,85 @@
An object of the form:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="changeRenewalSettings">changeRenewalSettings(customerId, subscriptionId, body)</code>
- <pre>Changes the renewal settings of a subscription
+ <pre>Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only.
Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
+ 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)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for a subscription renewal settings.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
}
@@ -264,68 +312,92 @@
An object of the form:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="changeSeats">changeSeats(customerId, subscriptionId, body)</code>
- <pre>Changes the seats configuration of a subscription
+ <pre>Update a subscription's user license settings.
Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
+ 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)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for subscription seats.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
}
@@ -334,305 +406,403 @@
An object of the form:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(customerId, subscriptionId, deletionType)</code>
- <pre>Cancels/Downgrades a subscription.
+ <pre>Cancel, suspend or transfer a subscription to direct.
Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
- deletionType: string, Whether the subscription is to be fully cancelled or downgraded (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
+ 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)
+ deletionType: string, The deletionType query string enables the cancellation, downgrade, or suspension of a subscription. (required)
Allowed values
- cancel - Cancels the subscription immediately
- downgrade - Downgrades a Google Apps for Business subscription to Google Apps
- suspend - Suspends the subscriptions for 4 days before cancelling it
- transfer_to_direct - Transfers a subscription directly to Google
+ cancel - Cancels the subscription immediately. This does not apply to a G Suite subscription.
+ downgrade - Downgrades a G Suite subscription to a Google Apps Free edition subscription only if the customer was initially subscribed to a Google Apps Free edition (also known as the Standard edition). Once downgraded, the customer no longer has access to the previous G Suite subscription and is no longer managed by the reseller.
+
+A G Suite subscription's downgrade cannot be invoked if an active or suspended Google Drive or Google Vault subscription is present. The Google Drive or Google Vault subscription must be cancelled before the G Suite subscription's downgrade is invoked.
+
+The downgrade deletionType does not apply to other products or G Suite SKUs.
+ suspend - (DEPRECATED) The G Suite account is suspended for four days and then cancelled. Once suspended, an administrator has access to the suspended account, but the account users can not access their services. A suspension can be lifted, using the reseller tools.
+
+A G Suite subscription's suspension can not be invoked if an active or suspended Google Drive or Google Vault subscription is present. The Google Drive or Google Vault subscription must be cancelled before the G Suite subscription's suspension is invoked.
+ 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.
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customerId, subscriptionId)</code>
- <pre>Gets a subscription of the customer.
+ <pre>Get a specific subscription.
Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
+ 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)
Returns:
An object of the form:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(customerId, body, customerAuthToken=None)</code>
- <pre>Creates/Transfers a subscription for the customer.
+ <pre>Create or transfer a subscription.
Args:
- customerId: string, Id of the Customer (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}
- customerAuthToken: string, An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.
+ customerAuthToken: string, The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer'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.
Returns:
An object of the form:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)</code>
- <pre>Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
+ <pre>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.
Args:
- customerAuthToken: string, An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional.
+ customerAuthToken: string, The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer'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.
pageToken: string, Token to specify next page in the list
- maxResults: integer, Maximum number of results to return
- customerNamePrefix: string, Prefix of the customer's domain name by which the subscriptions should be filtered. Optional
- customerId: string, Id of the Customer
+ 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.
+ 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:
+- exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*.
+- example -- Returns example20.com and example.com.
+ customerId: string, Either the customer's primary domain name or the customer'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.
Returns:
An object of the form:
{ # JSON template for a subscription list.
"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "reseller#subscriptions", # Identifies the resource as a collection of subscriptions.
+ "kind": "reseller#subscriptions", # Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions
"subscriptions": [ # The subscriptions in this page of results.
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
},
],
}</pre>
@@ -654,121 +824,157 @@
<div class="method">
<code class="details" id="startPaidService">startPaidService(customerId, subscriptionId)</code>
- <pre>Starts paid service of a trial subscription
+ <pre>Immediately move a 30-day free trial subscription to a paid service subscription.
Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
+ 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)
Returns:
An object of the form:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="suspend">suspend(customerId, subscriptionId)</code>
- <pre>Suspends an active subscription
+ <pre>Suspends an active subscription.
Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
+ customerId: string, Either the customer's primary domain name or the customer'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)
+ 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)
Returns:
An object of the form:
{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
+ "renewalSettings": { # 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.
+ "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
+ "renewalType": "A String", # 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.
},
- "dealCode": "A String", # External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
+ "dealCode": "A String", # 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.
"customerDomain": "A String", # Primary domain name of the customer
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
+ "trialSettings": { # The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
+ "trialEndTime": "A String", # Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "isInTrial": True or False, # Determines if a subscription's plan is in a 30-day free trial or not:
+ # - true — The plan is in trial.
+ # - false — The plan is not in trial.
},
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
+ "skuId": "A String", # A required property. The skuId is a unique system identifier for a product'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.
+ "resourceUiUrl": "A String", # URL to customer'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.
+ "seats": { # JSON template for subscription seats. # This is a required property. The number and limit of user seat licenses in the plan.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request. Value: subscriptions#seats
+ "numberOfSeats": 42, # The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan:
+ # - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers.
+ # - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.
+ "maximumNumberOfSeats": 42, # The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan:
+ # - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response.
+ # - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account.
+ # - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.
"licensedNumberOfSeats": 42, # Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
},
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
+ "creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
+ "kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
+ "transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
+ "minimumTransferableSeats": 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.
},
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
+ "status": "A String", # This is an optional property.
+ "plan": { # 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"s payment plans, see the API concepts.
+ "planName": "A String", # The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
+ #
+ # Possible values are:
+ # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+ # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+ # - FLEXIBLE — The flexible plan
+ # - 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.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year.
+ "endTime": "A String", # An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.
+ "startTime": "A String", # An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.
},
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
+ "isCommitmentPlan": True or False, # The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
+ # - true — The subscription's plan is an annual commitment plan.
+ # - false — The plan is not an annual commitment plan.
},
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
+ "purchaseOrderId": "A String", # 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.
+ "suspensionReasons": [ # Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
+ #
+ # Possible options include:
+ # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.
# - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
# - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
# - TRIAL_ENDED - The customer's trial expired without a plan selected.
# - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
"A String",
],
- "subscriptionId": "A String", # The id of the subscription.
- "billingMethod": "A String", # Billing method of this subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
+ "subscriptionId": "A String", # 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.
+ "billingMethod": "A String", # Read-only field that returns the current billing method for a subscription.
+ "customerId": "A String", # 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.
}</pre>
</div>