Method: subscriptions.suspend
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Suspende uma assinatura ativa.
Use esse método para suspender uma assinatura paga que está no estado ACTIVE.
- Para assinaturas do
FLEXIBLE, o faturamento é pausado.
- Para assinaturas
ANNUAL_MONTHLY_PAY ou ANNUAL_YEARLY_PAY:
- A suspensão da assinatura não muda a data de renovação que foi definida originalmente.
- Uma assinatura suspensa não é renovada. Se você ativar a assinatura após a data de renovação original, uma nova assinatura anual será criada, a partir do dia da ativação.
Recomendamos que você suspenda as assinaturas apenas por períodos curtos, já que suspensões de mais de 60 dias podem resultar no cancelamento da assinatura.
Solicitação HTTP
POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
customerId |
string
Pode ser o nome de domínio principal ou o identificador exclusivo do cliente. Se o nome de domínio de um cliente mudar, o nome antigo não poderá ser usado para acessar o cliente, mas o identificador exclusivo do cliente (retornado pela API) sempre poderá. Recomendamos armazenar o identificador exclusivo nos seus sistemas, quando aplicável.
|
subscriptionId |
string
Esta é uma propriedade obrigatória. O subscriptionId é o identificador da assinatura e é exclusivo para cada cliente. Como um subscriptionId muda quando uma assinatura é atualizada, recomendamos não usar esse ID como uma chave para dados persistentes. E o subscriptionId pode ser encontrado usando o método recuperar todas as assinaturas de revendedor.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Subscription.
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/apps.order
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# Method: subscriptions.suspend\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nSuspends an active subscription.\n\nYou can use this method to suspend a paid subscription that is currently in the `ACTIVE` state.\n\n- For `FLEXIBLE` subscriptions, billing is paused.\n- For `ANNUAL_MONTHLY_PAY` or `ANNUAL_YEARLY_PAY` subscriptions:\n - Suspending the subscription does not change the renewal date that was originally committed to.\n - 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.\n\nWe strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled.\n\n### HTTP request\n\n`POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `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](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Subscription](/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.order`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
