REST Resource: subscriptions

Recurso: Subscription

Modelo JSON para uma assinatura.

Representação JSON 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
Campos
customerId

string

Essa propriedade sempre será retornada em uma resposta como o identificador exclusivo gerado pelo Google. Em uma solicitação, essa propriedade pode ser o domínio principal ou o identificador exclusivo gerado pelo Google.
subscriptionId

string

O subscriptionId é o identificador da assinatura e é exclusivo para cada cliente. Esta é uma propriedade obrigatória. Como um subscriptionId muda quando uma assinatura é atualizada, recomendamos não usar esse ID como uma chave para dados persistentes. Use o subscriptionId conforme descrito em extrair todas as assinaturas de revendedor.
skuId

string

Uma propriedade obrigatória. O skuId é um identificador de sistema exclusivo para a SKU de um produto atribuída a um cliente na assinatura. Para saber quais produtos e SKUs estão disponíveis nesta versão da API, consulte IDs de produtos e SKUs.
creationTime

string (int64 format)

A propriedade creationTime é a data em que a assinatura foi criada. Ele está em milissegundos usando o formato Epoch. Confira um exemplo de conversor de Época.
kind

string

Identifica o recurso como uma assinatura. Valor: reseller#subscription
seats

object (Seats)

Esta é uma propriedade obrigatória. O número e o limite de licenças de usuário no plano.
renewalSettings

object (RenewalSettings)

Configurações de renovação do plano de compromisso anual. Para mais detalhes, consulte as opções de renovação na Central de Ajuda para administradores.
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.
status

string

Essa é uma propriedade opcional.
resourceUiUrl

string

URL da página "Assinaturas" do cliente no Admin Console. O URL somente leitura é gerado pelo serviço da API. Isso é usado quando o aplicativo cliente exige que o cliente conclua uma tarefa usando a página "Assinaturas" no Admin Console.
billingMethod

string

Campo somente leitura que retorna o método de faturamento atual de uma assinatura.
suspensionReasons[]

string

Campo somente leitura que contém um enumerable de todos os motivos de suspensão atuais de uma assinatura. É possível que uma assinatura tenha vários motivos de suspensão simultâneos e sobrepostos. O STATUS de uma assinatura é SUSPENDED até que todas as suspensões pendentes sejam removidas.

As opções possíveis incluem:

  • PENDING_TOS_ACCEPTANCE: o cliente não fez login e aceitou os Termos de Serviço de revenda do G Suite.
  • RENEWAL_WITH_TYPE_CANCEL: o compromisso do cliente terminou e o serviço foi cancelado no final do período.
  • RESELLER_INITIATED: uma suspensão manual invocada por um revendedor.
  • TRIAL_ENDED: o teste do cliente expirou sem um plano selecionado.
  • OTHER: o cliente foi suspenso por um motivo interno do Google (por exemplo, abuso ou outro motivo).

customerDomain

string

Nome do domínio principal do cliente
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 nas solicitações de insert para receber a tarifa com desconto. Essa propriedade é opcional. Se ela for deixada em branco, o preço normal será aplicado.
skuName

string

Nome externo de exibição somente leitura para a SKU de um produto atribuída a um cliente na assinatura. Os nomes de SKU estão sujeitos a mudanças a critério do Google. Para saber quais produtos e SKUs estão disponíveis nesta versão da API, consulte IDs de produtos e SKUs.
plan

object

A propriedade plan é obrigatória. Nesta versão da API, os planos do G Suite são o flexível, o de compromisso anual e o de teste sem custo financeiro de 30 dias. Para mais informações sobre os planos de pagamento da API, consulte os conceitos da API.
plan.planName

string

A propriedade planName é obrigatória. É o nome do plano 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: o plano flexível
  • TRIAL: o plano de teste sem custo financeiro de 30 dias. Uma assinatura em teste será suspensa após o 30º dia sem custo financeiro se nenhum plano de pagamento for atribuído. Chamar changePlan vai atribuir um plano de pagamento a um teste, mas não vai ativar o plano. O teste vai começar automaticamente o plano de pagamento atribuído após o 30º dia sem custo financeiro ou imediatamente após a chamada para startPaidService.
  • FREE: o plano sem custo financeiro é exclusivo para a SKU do Cloud Identity e não gera faturamento.

plan.isCommitmentPlan

boolean

O valor booleano da propriedade isCommitmentPlan identifica o plano como um plano de compromisso anual:

  • true: o plano da assinatura é um plano de compromisso anual.
  • false: o plano não é de compromisso anual.
plan.commitmentInterval

object

Nesta versão da API, o intervalo do plano de compromisso anual é de um ano.

plan.commitmentInterval.startTime

string (int64 format)

O startTime do intervalo de um plano de compromisso anual em milissegundos usando o formato de época UNIX. Confira um exemplo de conversor de Época.
plan.commitmentInterval.endTime

string (int64 format)

O endTime do intervalo de um plano de compromisso anual em milissegundos usando o formato de Época UNIX. Confira um exemplo de conversor de Época.
trialSettings

object

O compromisso anual do G Suite e os planos de pagamento flexíveis podem ser usados em um teste sem custo financeiro de 30 dias. Para mais informações, consulte os conceitos de API.
trialSettings.isInTrial

boolean

Determina se o plano de uma assinatura está em um teste sem custo financeiro de 30 dias ou não:

  • true: o plano está em teste.
  • false: o plano não está em teste.
trialSettings.trialEndTime

string (int64 format)

Data em que o teste termina. O valor está em milissegundos usando o formato de época UNIX. Confira um exemplo de conversor de Época.
transferInfo

object

Informações relacionadas à transferência de leitura somente para a assinatura. Para mais informações, consulte Extrair assinaturas transferíveis de um cliente.
transferInfo.transferabilityExpirationTime

string (int64 format)

O horário de expiração do token de transferência ou da intent de transferência. O tempo está em milissegundos usando o formato de época Unix.
transferInfo.minimumTransferableSeats

integer

Ao inserir uma assinatura, esse é o número mínimo de assentos listados no pedido de transferência para esse produto. Por exemplo, se o cliente tiver 20 usuários, o revendedor não poderá fazer um pedido de transferência de 15 vagas. O mínimo é de 20 lugares.
transferInfo.currentLegacySkuId

string

O skuId da assinatura revendida atual. Esse campo é preenchido apenas quando o cliente tem uma assinatura com uma SKU legada e o recurso de assinatura é preenchido com o skuId da SKU recomendada para a transferência.

Lugares

Modelo JSON para assentos de assinatura.

Representação JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Campos
numberOfSeats

integer

Essa é uma propriedade obrigatória e exclusiva para assinaturas com planos ANNUAL_MONTHLY_PAY e ANNUAL_YEARLY_PAY. Ela define o número máximo de licenças atribuíveis aos usuários em uma assinatura. O revendedor pode adicionar mais licenças, mas, depois de definido, o numberOfSeats não pode ser reduzido até a renovação. A cobrança do revendedor é baseada no valor de numberOfSeats, independentemente de quantas licenças de usuário são atribuídas.

maximumNumberOfSeats

integer

Essa é uma propriedade obrigatória e exclusiva para assinaturas com planos FLEXIBLE ou TRIAL. Ela define o número máximo de usuários licenciados permitidos em uma assinatura. Essa quantidade pode ser aumentada até o limite máximo definido no contrato do revendedor. A quantidade mínima é o número atual de usuários na conta do cliente.

licensedNumberOfSeats

integer

Campo somente leitura que contém o número atual de usuários atribuídos a uma licença para o produto definido em skuId. O valor desse campo é equivalente à contagem numérica de usuários retornada pelo método da API Enterprise License Manager: listForProductAndSku.
kind

string

Identifica o recurso como uma configuração de assento de assinatura. Valor: subscriptions#seats

RenewalSettings

Modelo JSON para configurações de renovação de assinatura.

Representação JSON 
{
  "renewalType": string,
  "kind": string
}
Campos
renewalType

string

Configurações de renovação do plano de compromisso anual. Para mais detalhes, consulte as opções de renovação na Central de Ajuda para administradores. Ao renovar uma assinatura, a renewalType é uma propriedade obrigatória.
kind

string

Identifica o recurso como uma configuração de renovação de assinatura. Valor: subscriptions#renewalSettings

Métodos

activate

 Ativa uma assinatura que foi suspensa pelo revendedor.

changePlan

 Atualiza um plano de assinatura.

changeRenewalSettings

 Atualiza as configurações de renovação da licença de um usuário.

changeSeats

 Atualiza as configurações da licença de usuário de uma assinatura.

delete

 Cancela, suspende ou transfere uma assinatura para o Direct.

get

 Recebe uma assinatura específica.

insert

 Cria ou transfere uma assinatura.

list

 Listas de assinaturas gerenciadas pelo revendedor.

startPaidService

 Mudar imediatamente uma assinatura de teste sem custo financeiro de 30 dias para uma assinatura paga.

suspend

 Suspende uma assinatura ativa.