Method: subscriptions.suspend
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Suspende una suscripción activa.
Puedes usar este método para suspender una suscripción pagada que esté en el estado ACTIVE.
- En el caso de las suscripciones a
FLEXIBLE, se pausa la facturación.
- Para suscripciones a
ANNUAL_MONTHLY_PAY o ANNUAL_YEARLY_PAY:
- Suspender la suscripción no cambia la fecha de renovación acordada originalmente.
- Una suscripción suspendida no se renueva. Si activas la suscripción después de la fecha de renovación original, se creará una nueva suscripción anual a partir del día de la activación.
Te recomendamos que suspendas las suscripciones solo por períodos cortos, ya que las suspensiones superiores a 60 días pueden provocar que se cancelen.
Solicitud HTTP
POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
customerId |
string
Puede ser el nombre de dominio principal del cliente o su identificador único. Si cambia el nombre de dominio de un cliente, no se puede usar el nombre de dominio anterior para acceder a él, pero siempre se puede usar el identificador único del cliente (como lo muestra la API). Te recomendamos que almacenes el identificador único en tus sistemas cuando corresponda.
|
subscriptionId |
string
Esta es una propiedad obligatoria. subscriptionId es el identificador de suscripción y es único para cada cliente. Dado que un subscriptionId cambia cuando se actualiza una suscripción, te recomendamos que no uses este ID como clave para los datos persistentes. Y puedes encontrar el subscriptionId con el método recuperar todas las suscripciones de revendedor.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Subscription.
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/apps.order
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]
