Method: subscriptions.changePlan

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

A forma como um plano é atualizado 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 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.

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 subscriptions.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 mudança de plano de assinatura. Valor: subscriptions#changePlanRequest

planName

string

A propriedade planName é obrigatória. É o nome do plano de pagamento da assinatura. Para mais informações sobre os planos de pagamento do Google, consulte 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: o plano de teste sem custo financeiro de 30 dias

seats

object (Seats)

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

purchaseOrderId

string

Essa é uma propriedade opcional. Essas informações de ordem de compra (OC) são para que os revendedores usem no rastreamento 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 changePlan para receber a tarifa 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 tarifa com desconto ainda será aplicada. Se não estiver em branco, informe apenas o código de oferta que já está na assinatura. Se um código de oferta nunca tiver sido adicionado a uma assinatura e essa propriedade for deixada em branco, o preço normal será aplicado.