Method: subscriptions.suspend
Suspends an active subscription.
You can use this method to suspend a paid subscription that is currently in the ACTIVE state.
- For
FLEXIBLE subscriptions, billing is paused.
- For
ANNUAL_MONTHLY_PAY or ANNUAL_YEARLY_PAY subscriptions:
- Suspending the subscription does not change the renewal date that was originally committed to.
- A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation.
We strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled.
HTTP request
POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend
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 must be empty.
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."],[[["Suspends an active subscription, pausing billing for `FLEXIBLE` subscriptions and preventing renewals for annual subscriptions."],["Suspensions over 60 days may lead to subscription cancellation, shorter suspensions are recommended."],["Uses `POST` request to `https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend`, requiring `customerId` and `subscriptionId`."],["Request body should be empty, and a successful response returns a `Subscription` object."],["Requires authorization with the `https://www.googleapis.com/auth/apps.order` scope."]]],["This API method suspends a paid subscription in the `ACTIVE` state. For `FLEXIBLE` subscriptions, billing pauses. For `ANNUAL` subscriptions, renewal is halted but the original date remains; post-renewal reactivation creates a new subscription. The HTTP request is a `POST` to a specific URL including `customerId` and `subscriptionId` path parameters. The request body should be empty and the successful response contains a `Subscription` instance. Authorization requires the `https://www.googleapis.com/auth/apps.order` scope.\n"]]
