Method: subscriptions.delete

Cancela, suspende o transfiere una suscripción a suscripción directa.

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 podrá usar el nombre de dominio anterior para acceder al cliente, pero siempre se podrá 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 propiedad es obligatoria. El subscriptionId es el identificador de la suscripción y es único para cada cliente. Dado que subscriptionId cambia cuando se actualiza una suscripción, te recomendamos que no uses este ID como clave para datos persistentes. Y el subscriptionId se puede encontrar con el método recuperar todas las suscripciones de revendedores.

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, tanto en la solicitud como 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

Enumeradores
deletion_type_undefined
cancel Cancela la suscripción de inmediato. Esto no se aplica a las suscripciones a G Suite.
transfer_to_direct

Transfiere una suscripción directamente a Google. El cliente se transfiere inmediatamente a una relación de facturación directa con Google y se le asigna un breve período de tiempo sin que se interrumpa el servicio. El cliente puede elegir configurar la facturación directamente con Google mediante una tarjeta de crédito o puede transferirla a otro revendedor.