Method: subscriptions.delete

Cancela, suspende ou transfere uma assinatura para o Direct.

Solicitação HTTP

DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}

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.

Parâmetros de consulta

Parâmetros
deletionType

enum (DeletionType)

A string de consulta deletionType permite o cancelamento, o downgrade ou a suspensão de uma assinatura.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

É a mensagem que representa um corpo HTTP arbitrário. Use-a somente para formatos de payload que não podem ser representados como JSON, por exemplo, binário bruto ou uma página HTML.

É possível usar essa mensagem em métodos de API de streaming e não streaming na solicitação e na resposta.

Ela pode ser usada como um campo de solicitação de nível superior, o que será conveniente se você quiser extrair parâmetros do modelo de URL ou HTTP para os campos da solicitação e também quiser acessar o corpo HTTP bruto.

Exemplo:

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);

}

Exemplo com métodos de streaming:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

O uso desse tipo altera somente o modo como os corpos de solicitação e resposta são tratados. Todos os outros recursos continuarão a funcionar sem alteração.

Se for bem-sucedida, a resposta será uma resposta HTTP genérica que tem o formato definido pelo método.

Representação JSON 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
contentType

string

O valor do cabeçalho HTTP Content-Type que especifica o tipo de conteúdo do corpo.
data

string (bytes format)

O corpo da solicitação/resposta HTTP como binário bruto.

Uma string codificada em base64.
extensions[]

object

Metadados de resposta específicos do aplicativo. Precisam ser definidos na primeira resposta para APIs de streaming.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

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.

DeletionType

Enums
deletion_type_undefined
cancel Cancela a assinatura imediatamente. Isso não se aplica a uma assinatura do G Suite.
transfer_to_direct

Transfere uma assinatura diretamente para o Google.  O cliente é transferido imediatamente para uma relação de faturamento direto com o Google e recebe um curto período sem interrupção do serviço. O cliente pode escolher configurar o faturamento diretamente com o Google usando um cartão de crédito ou transferir para outro revendedor.