Method: subscriptions.changePlan

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

A forma de atualização de um plano varia de acordo com o plano e os produtos. Para mais informações, consulte 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 acessar o cliente, mas o identificador exclusivo do cliente (conforme retornado pela API) poderá sempre ser usado. Recomendamos armazenar o identificador exclusivo nos seus sistemas, quando aplicável.
subscriptionId

string

Essa é uma propriedade obrigatória. O subscriptionId é o identificador de assinatura e é exclusivo para cada cliente. Como um subscriptionId muda quando uma assinatura é atualizada, recomendamos não usar esse ID como chave para dados persistentes. E o subscriptionId pode ser encontrado usando o método Recuperar todas as assinaturas do 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 de 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 alteração 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 de 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: o plano flexível
  • TRIAL: plano de teste sem custo financeiro de 30 dias

seats

object (Seats)

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

string

Essa propriedade é opcional. Estas informações de ordem de compra (OC) são destinadas aos revendedores para rastrear o uso nas próprias empresas. Se um valor purchaseOrderId for fornecido, ele 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 descontos nos planos de assinatura. O código de oferta precisa ser incluído na solicitação de changePlan para receber o desconto. Esta propriedade é opcional. Se um código da transação já tiver sido adicionado a uma assinatura, esta propriedade pode ficar em branco e a taxa com desconto atual ainda será aplicada. Se não estiver, forneça apenas o código da transação 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.