Method: subscriptions.changeRenewalSettings
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.
HTTP request
POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
customerId |
string
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.
|
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.
|
Request body
The request body contains an instance of RenewalSettings
.
Response body
If successful, the response body contains an instance of Subscription
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/apps.order
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["Updates a user license's renewal settings, specifically for accounts with annual commitment plans."],["Uses the `changeRenewalSettings` endpoint with customer and subscription IDs as path parameters."],["Requires providing `RenewalSettings` in the request body and returns an updated `Subscription` object if successful."],["Needs authorization with the `https://www.googleapis.com/auth/apps.order` scope for access."]]],["The core action is updating a user license's renewal settings for annual commitment plans via a POST request to `https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings`. The request requires `customerId` (domain or unique ID) and `subscriptionId` as path parameters. The request body must be a `RenewalSettings` instance, and a successful response returns a `Subscription` instance. Authorization needs the `https://www.googleapis.com/auth/apps.order` OAuth scope.\n"]]