v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13171054.0 KB
subscriptions

Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in manage subscriptions.

post/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings

Path parameters

customerIdstring required

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.

subscriptionIdstring required

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.

Request body

kindstring

Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings

renewalTypestring

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.

Response

Successful response