Subscriptions: changeRenewalSettings

Requires authorization

Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. Try it now.

For more information, see the description in manage subscriptions.

Request

HTTP request

POST https://www.googleapis.com/apps/reseller/v1/customers/customerId/subscriptions/subscriptionId/changeRenewalSettings

Parameters

Parameter name Value Description
Path parameters
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.
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.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/apps.order

Request body

In the request body, supply data with the following structure:

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": string
}
Property name Value Description Notes
kind string Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings
renewalType 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.

Acceptable values are:
  • "AUTO_RENEW_MONTHLY_PAY": At the end of an annual commitment plan's interval, automatically renew the subscription plan with monthly payments and with the same number of user licenses.
  • "AUTO_RENEW_YEARLY_PAY": At the end of an annual commitment plan's interval, automatically renew the subscription plan with yearly payments and the same number of user licenses.
  • "CANCEL": At the end of an annual commitment plan's interval, the customer's account is suspended. To re-activate a suspended account, call activate<\code>.
  • "RENEW_CURRENT_USERS_MONTHLY_PAY": At the end of an annual commitment plan's interval, renew the subscription plan with monthly payments but use the total number of current active user licenses.
  • "RENEW_CURRENT_USERS_YEARLY_PAY": At the end of an annual commitment plan's interval, renew the subscription plan with yearly payments but use the total number of current active user licenses.
  • "SWITCH_TO_PAY_AS_YOU_GO": At the end of an annual commitment plan's interval, change the annual commitment plan to a flexible plan.

Response

If successful, this method returns a Subscriptions resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.

Enviar comentarios sobre…

G Suite Reseller API
G Suite Reseller API