Method: subscriptions.delete
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Cancela, suspende o transfiere una suscripción a Direct.
Solicitud HTTP
DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}
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.
|
Parámetros de consulta
Parámetros |
deletionType |
enum (DeletionType )
La cadena de consulta deletionType permite cancelar, cambiar a una versión inferior o suspender una suscripción.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Mensaje que representa un cuerpo HTTP arbitrario. Solo debería usarse para formatos de carga útil que no pueden representarse como JSON, por ejemplo, datos binarios sin procesar o una página HTML.
Este mensaje se puede usar en métodos de API de transmisión y de no transmisión, en la solicitud y en la respuesta.
Se puede usar como campo de solicitud de alto nivel, que es conveniente si alguien quiere extraer parámetros de la plantilla de URL o HTTP para los campos de solicitudes y también quiere acceder al cuerpo HTTP sin procesar.
Ejemplo:
message GetResourceRequest {
// A unique request id.
string requestId = 1;
// The raw HTTP body is bound to this field.
google.api.HttpBody http_body = 2;
}
service ResourceService {
rpc GetResource(GetResourceRequest)
returns (google.api.HttpBody);
rpc UpdateResource(google.api.HttpBody)
returns (google.protobuf.Empty);
}
Ejemplo con métodos de transmisión:
service CaldavService {
rpc GetCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
rpc UpdateCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
}
El uso de este tipo solo cambia la manera en que se manejan los cuerpos de la solicitud y la respuesta. Las demás funciones seguirán funcionando sin cambios.
Si se ejecuta de forma correcta, la respuesta es una respuesta HTTP genérica, y el método define su formato.
Representación JSON |
{
"contentType": string,
"data": string,
"extensions": [
{
"@type": string,
field1: ...,
...
}
]
} |
Campos |
contentType |
string
El valor del encabezado HTTP de Content-Type que especifica el tipo de contenido del cuerpo.
|
data |
string (bytes format)
El cuerpo de la solicitud/respuesta HTTP como objeto binario sin procesar. String codificada en base 64.
|
extensions[] |
object
Metadatos de la respuesta específica de la aplicación. Se deben configurar en la primera respuesta para las API de transmisión. Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
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.
DeletionType
Enumeraciones |
deletion_type_undefined |
|
cancel |
Cancela la suscripción de inmediato. Esto no se aplica a una suscripción a G Suite. |
transfer_to_direct |
Transfiere una suscripción directamente a Google. El cliente se transfiere de inmediato a una relación de facturación directa con Google y se le otorga un período breve sin interrupciones del servicio. Luego, el cliente puede elegir configurar la facturación directamente con Google mediante una tarjeta de crédito o transferirla a otro distribuidor. |
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.delete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.HttpBody.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [DeletionType](#DeletionType)\n- [Try it!](#try-it)\n\nCancels, suspends, or transfers a subscription to direct.\n\n### HTTP request\n\n`DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}`\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### Query parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deletionType` | `enum (`[DeletionType](/workspace/admin/reseller/reference/rest/v1/subscriptions/delete#DeletionType)`)` The `deletionType` query string enables the cancellation, downgrade, or suspension of a subscription. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nMessage that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.\n\nThis message can be used both in streaming and non-streaming API methods in the request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.\n\nExample: \n\n message GetResourceRequest {\n // A unique request id.\n string requestId = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest)\n returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody)\n returns (google.protobuf.Empty);\n\n }\n\nExample with streaming methods: \n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n\n }\n\nUse of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"contentType\": string, \"data\": string, \"extensions\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `contentType` | `string` The HTTP Content-Type header value specifying the content type of the body. |\n| `data` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` The HTTP request/response body as raw binary. A base64-encoded string. |\n| `extensions[]` | `object` Application specific response metadata. Must be set in the first response for streaming APIs. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |\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).\n\nDeletionType\n------------\n\n| Enums ||\n|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deletion_type_undefined` | |\n| `cancel` | Cancels the subscription immediately. This does not apply to a G Suite subscription. |\n| `transfer_to_direct` | Transfers a subscription directly to Google. The customer is immediately transferred to a direct billing relationship with Google and is given a short amount of time with no service interruption. The customer can then choose to set up billing directly with Google by using a credit card, or they can transfer to another reseller. |"]]