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 vai 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 de assinatura e é exclusivo para cada cliente. Essa é uma propriedade obrigatória. Como um subscriptionId muda quando uma assinatura é atualizada, recomendamos não usar esse ID como chave para dados persistentes. Use o subscriptionId conforme descrito em Recuperar todas as assinaturas do revendedor.
skuId

string

Uma propriedade obrigatória. O skuId é um identificador de sistema exclusivo para a SKU de um produto, atribuído a um cliente na assinatura. Para ver os produtos e SKUs disponíveis nessa 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. Ela está em milissegundos e usa o formato Époch. Confira um exemplo de conversor Epoch.
kind

string

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

object (Seats)

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

string

Essa propriedade é opcional.
resourceUiUrl

string

URL para a página "Assinaturas" do cliente no Admin Console. O URL somente leitura é gerado pelo serviço de API. Usado se o aplicativo cliente exigir que o cliente conclua uma tarefa na página "Assinaturas" do Admin Console.
billingMethod

string

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

string

Campo somente leitura contendo uma lista enumerada de todos os motivos de suspensão atuais de uma assinatura. Uma assinatura pode ter vários motivos de suspensão simultâneos e sobrepostos. O STATUS de uma assinatura é de 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 ao final da vigência.
  • 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 de domínio principal do cliente
dealCode

string

Código emitido pelo Google (máximo de 100 caracteres) para descontos nos planos de assinatura. O código da oferta precisa ser incluído nas solicitações do insert para que seja possível receber o desconto. Esta propriedade é opcional. O preço normal será aplicado se for deixado em branco.
skuName

string

Nome de exibição externo somente leitura da SKU de um produto atribuído a um cliente na assinatura. Os nomes das SKUs estão sujeitos a alterações a critério do Google. Para ver os produtos e SKUs disponíveis nessa 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 plano flexível, o plano com contrato anual e o plano de teste sem custo financeiro de 30 dias. Para mais informações sobre os planos de pagamento da API, consulte os conceitos de API.
plan.planName

string

A propriedade planName é obrigatória. Este é o nome do plano 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 — O plano de teste sem custo financeiro de 30 dias. Uma assinatura em teste será suspensa após o 30o dia sem custo financeiro se nenhum plano de pagamento for atribuído. Ligar para changePlan atribui um plano de pagamento a um teste, mas não ativa o plano. O teste vai começar automaticamente após o 30o dia sem custo financeiro ou imediatamente após chamar 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 é um plano 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 UNIX Epoch. Confira um exemplo de conversor Epoch.
plan.commitmentInterval.endTime

string (int64 format)

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

object

O compromisso anual do G Suite e os planos de pagamento flexíveis podem ser incluídos em uma avaliação sem custo financeiro de 30 dias. Para mais informações, consulte os conceitos da 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 de término do teste. O valor aparece em milissegundos no formato UNIX Epoch. Confira um exemplo de conversor Epoch.
transferInfo

object

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

string (int64 format)

O horário em que o token ou a intent de transferência expira. A hora está em milissegundos no formato UNIX Epoch.
transferInfo.minimumTransferableSeats

integer

Ao inserir uma assinatura, esse é o número mínimo de licenças listadas na ordem de transferência do produto. Por exemplo, se o cliente tiver 20 usuários, o revendedor não poderá fazer um pedido de transferência de 15 licenças. O mínimo é de 20 licenças.
transferInfo.currentLegacySkuId

string

O skuId da assinatura de revenda atual. Isso é 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 vagas 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 os planos ANNUAL_MONTHLY_PAY e ANNUAL_YEARLY_PAY. Esta propriedade define o número máximo de licenças que podem ser atribuídas 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 fatura do revendedor é baseada no valor de numberOfSeats, seja qual for o número de licenças de usuário atribuídas.

maximumNumberOfSeats

integer

Essa é uma propriedade obrigatória e exclusiva para assinaturas com planos FLEXIBLE ou TRIAL. Esta propriedade 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 contendo o número atual de usuários que recebem uma licença do produto definido em skuId. O valor desse campo é equivalente à contagem numérica de usuários retornados pelo método da API Enterprise License Manager: listForProductAndSku.
kind

string

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

RenewalSettings

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

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

string

Configurações de renovação para o plano de compromisso anual. Para informações mais detalhadas, consulte as opções de renovação na Central de Ajuda para administradores. Ao renovar uma assinatura, o 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 suspensa anteriormente pelo revendedor.

changePlan

 Atualiza um plano de assinatura.

changeRenewalSettings

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

changeSeats

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

delete

 Cancela, suspende ou transfere uma assinatura para venda direta.

get

 Recebe uma assinatura específica.

insert

 Cria ou transfere uma assinatura.

list

 Listas de assinaturas gerenciadas pelo revendedor.

startPaidService

 Mover imediatamente uma assinatura de teste sem custo financeiro de 30 dias para uma assinatura de serviço pago.

suspend

 Suspende uma assinatura ativa.