REST Resource: subscriptions

Recurso: Subscription

Modelo JSON de 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 uma subscriptionId muda quando uma assinatura é atualizada, recomendamos não usar esse ID como uma chave para os dados persistentes. Use o subscriptionId conforme descrito em Recuperar todas as assinaturas de revendedor.

skuId

string

Uma propriedade obrigatória. O skuId é um identificador exclusivo do sistema para um SKU de produto atribuído a um cliente na assinatura. Para 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. Ele é em milissegundos usando o formato Época. Veja 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 do usuário no plano.

renewalSettings

object (RenewalSettings)

Configurações de renovação do plano de compromisso anual. Para informações mais detalhadas, consulte as opções de renovação na Central de Ajuda do administrador.

purchaseOrderId

string

Essa propriedade é opcional. Estas informações da ordem de compra (PO, na sigla em inglês) são para os revendedores usarem o acompanhamento da empresa. Se um valor purchaseOrderId for informado, ele aparecerá nas respostas da API e aparecerá 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 da API. Isso é usado quando o aplicativo cliente exige a conclusão de 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 enumeração de todos os motivos atuais de suspensão de uma assinatura. É possível que uma assinatura tenha muitos motivos de suspensão simultâneos e sobrepostos. O STATUS do assinatura será SUSPENDED até que todas as suspensões pendentes sejam removidas.

As opções disponíveis são as seguintes:

  • 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 fim 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 é suspenso por um motivo interno do Google (por exemplo, abuso ou de outra forma).

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 em solicitações insert para receber a taxa com desconto. Essa propriedade é opcional. Se os valores forem vazios, eles serão aplicados.

skuName

string

Nome de exibição externo somente leitura para um SKU de produto atribuído a um cliente na assinatura. Os nomes das SKUs estão sujeitos a mudanças a critério do Google. Para 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 flexível, o anual e o 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. A assinatura de teste será suspensa após o 30o dia sem custo financeiro se nenhum plano de pagamento for atribuído. Chamar changePlan atribuirá um plano de pagamento a um teste, mas não o ativará. O teste começará automaticamente no plano de pagamento atribuído após o 30o dia sem custo financeiro ou imediatamente após ligar para o startPaidService.
  • FREE: o plano sem custos financeiros é exclusivo da SKU do Cloud Identity e não gera cobranças.

plan.isCommitmentPlan

boolean

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

  • true: o plano de assinatura é anual.
  • false: o plano não é 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)

Um intervalo de compromisso anual (startTime) em milissegundos usando o formato de época UNIX. Veja um exemplo de conversor de época.

plan.commitmentInterval.endTime

string (int64 format)

Um intervalo de compromisso anual (endTime) em milissegundos usando o formato de época UNIX. Veja um exemplo de conversor de época.

trialSettings

object

O compromisso anual do G Suite e os planos de pagamento flexíveis podem ter um teste 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 é em milissegundos usando o formato UNIX Époch. Veja um exemplo de conversor de época.

transferInfo

object

Informações relacionadas à transferência somente leitura da assinatura. Para saber mais, consulte Recuperar assinaturas transferíveis para um cliente.

transferInfo.transferabilityExpirationTime

string (int64 format)

O momento em que o token ou a intent da transferência expira. A hora é em milissegundos usando o formato UNIX Époch.

transferInfo.minimumTransferableSeats

integer

Ao inserir uma assinatura, esse é o número mínimo de licenças listados no pedido 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 é 20 licenças.

transferInfo.currentLegacySkuId

string

É o skuId da assinatura de revenda atual. Isso é preenchido apenas quando o cliente tem uma assinatura com um SKU legado e o recurso de assinatura é preenchido com o skuId do SKU recomendado para a transferência.

Lugares

Modelo JSON para licenças de assinatura.

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

integer

Esta é uma propriedade obrigatória e exclusiva para assinaturas com planos ANNUAL_MONTHLY_PAY e ANNUAL_YEARLY_PAY. Esta propriedade 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 poderá ser reduzido até a renovação. O revendedor é faturado com base no valor de numberOfSeats, independentemente de quantas dessas licenças de usuário foram atribuídas.

maximumNumberOfSeats

integer

Esta é 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 de cliente.

licensedNumberOfSeats

integer

Campo somente leitura contendo o número atual de usuários que receberam uma licença para o produto definido no skuId. Este valor de 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 de assinatura. Valor: subscriptions#seats

RenewalSettings

Modelo JSON para uma configuração 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 informações mais detalhadas, consulte as opções de renovação na Central de Ajuda do administrador. 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 previamente suspensa 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 o direto.

get

Recebe uma assinatura específica.

insert

Cria ou transfere uma assinatura.

list

Listas de assinaturas gerenciadas pelo revendedor.

startPaidService

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

suspend

Suspende uma assinatura ativa.