Subscriptions: suspend

Requires authorization

Suspends an active subscription. Try it now.

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.

Request

HTTP request

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

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

Do not supply a request body with this method.

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.

Send feedback about...

G Suite Reseller API
G Suite Reseller API
Need help? Visit our support page.