Method: subscriptions.changePlan

Atualiza um plano de assinatura. Use este método para atualizar um plano de teste de 30 dias ou uma assinatura de plano flexível para um plano anual com pagamentos mensais ou anuais.

A atualização de um plano varia de acordo com o plano e os produtos. Para saber mais, confira a descrição em Gerenciar assinaturas.

Solicitação HTTP

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

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 de domínio antigo não poderá ser usado para acessá-lo, mas o identificador exclusivo do cliente (retornado pela API) sempre poderá ser usado. Recomendamos que você armazene o identificador exclusivo nos seus sistemas quando aplicável.

subscriptionId

string

Essa é uma propriedade obrigatória. O subscriptionId é o identificador da assinatura, exclusivo para cada cliente. Como um subscriptionId muda quando uma assinatura é atualizada, recomendamos não usar esse ID como uma chave para dados permanentes. O subscriptionId pode ser encontrado usando o método recuperar todas as assinaturas de revendedor.

Corpo da solicitação

O corpo da solicitação contém uma instância de ChangePlanRequest.

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.

ChangePlanRequest

Modelo JSON para a solicitação RPC Subscription.changePlan.

Representação JSON
{
  "kind": string,
  "planName": string,
  "seats": {
    object (Seats)
  },
  "purchaseOrderId": string,
  "dealCode": string
}
Campos
kind

string

Identifica o recurso como uma solicitação de plano de mudança de assinatura. Valor: subscriptions#changePlanRequest

planName

string

A propriedade planName é obrigatória. Esse é o nome do plano de pagamento da assinatura. Para mais informações sobre os planos de pagamento do Google, consulte os conceitos da API.

Os valores possíveis são:

  • ANNUAL_MONTHLY_PAY: o plano de compromisso anual com pagamentos mensais
  • ANNUAL_YEARLY_PAY: o plano de compromisso anual com pagamentos anuais
  • FLEXIBLE: plano flexível
  • TRIAL: plano de teste sem custo financeiro de 30 dias

seats

object (Seats)

Essa é uma propriedade obrigatória. A propriedade de assentos é o número de licenças de usuário.

purchaseOrderId

string

Essa propriedade é opcional. Essas informações da ordem de compra (PO, na sigla em inglês) são usadas pelos revendedores para rastrear o uso da empresa. Se um valor purchaseOrderId for fornecido, ele vai aparecer nas respostas da API e na fatura. A propriedade aceita até 80 caracteres de texto simples.

dealCode

string

Código emitido pelo Google (máximo de 100 caracteres) para preços com desconto em planos de assinatura. O código da oferta precisa ser incluído na solicitação de changePlan para receber o preço com desconto. Esta propriedade é opcional. Se um código de oferta já tiver sido adicionado a uma assinatura, essa propriedade poderá ser deixada em branco, e a taxa com desconto atual ainda será aplicada. Se não estiver em branco, forneça apenas o código da oferta que já está presente na assinatura. Se um código de oferta nunca tiver sido adicionado a uma assinatura e esta propriedade for deixada em branco, o preço normal será aplicado.