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
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["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."]]],[]]
