Regen all docs. (#700)
* Stop recursing if discovery == {}
* Generate docs with 'make docs'.
diff --git a/docs/dyn/reseller_v1.subscriptions.html b/docs/dyn/reseller_v1.subscriptions.html
index 19a66fa..807fae7 100644
--- a/docs/dyn/reseller_v1.subscriptions.html
+++ b/docs/dyn/reseller_v1.subscriptions.html
@@ -88,7 +88,7 @@
<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">Cancel, suspend or transfer a subscription to direct.</p>
+<p class="firstline">Cancel or transfer a subscription to direct.</p>
<p class="toc_element">
<code><a href="#get">get(customerId, subscriptionId)</a></code></p>
<p class="firstline">Get a specific subscription.</p>
@@ -135,16 +135,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -158,11 +152,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -201,23 +196,17 @@
"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_MONTHLY_PAY - The annual commitment plan with monthly payments Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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.
}
@@ -242,16 +231,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -265,11 +248,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -329,16 +313,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -352,11 +330,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -392,16 +371,10 @@
The object takes the form of:
{ # JSON template for subscription seats.
- "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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
}
@@ -424,16 +397,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -447,11 +414,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -478,7 +446,7 @@
<div class="method">
<code class="details" id="delete">delete(customerId, subscriptionId, deletionType)</code>
- <pre>Cancel, suspend or transfer a subscription to direct.
+ <pre>Cancel or transfer a subscription to direct.
Args:
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)
@@ -486,14 +454,6 @@
deletionType: string, The deletionType query string enables the cancellation, downgrade, or suspension of a subscription. (required)
Allowed values
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>
@@ -525,16 +485,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -548,11 +502,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -602,16 +557,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -625,11 +574,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -674,16 +624,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -697,11 +641,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -762,16 +707,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -785,11 +724,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -857,16 +797,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -880,11 +814,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},
@@ -936,16 +871,10 @@
"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.
+ "kind": "subscriptions#seats", # Identifies the resource as a subscription seat setting. Value: subscriptions#seats
+ "numberOfSeats": 42, # This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.
+ "maximumNumberOfSeats": 42, # This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.
+ "licensedNumberOfSeats": 42, # Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku
},
"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
@@ -959,11 +888,12 @@
"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_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
# - 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.
+ # - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
+ "commitmentInterval": { # In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
"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.
},