Criar ou transferir uma assinatura

Depois de pedir a conta de um cliente, é possível criar várias assinaturas diferentes:

  • Uma assinatura de compromisso anual
  • Uma assinatura flexível
  • Um teste sem custo financeiro de 30 dias
  • Uma assinatura com desconto

Para mais informações sobre os produtos usados nessas assinaturas, consulte Produtos e SKUs.

Se você não tiver pedido a conta desse cliente, poderá transferir uma assinatura.

Os clientes com customerType = 'team' só podem comprar as edições Essentials e Enterprise Essentials do Google Workspace. Se você tentar comprar qualquer outra assinatura do Google Workspace, vai receber o erro Customer is not eligible to purchase this subscription. Os clientes que comprarem assinaturas do Essentials ou baseadas no uso talvez não consigam usar planos de compromisso anual e terão opções limitadas de upgrade e downgrade.

Crie uma assinatura

Para criar uma assinatura para a conta de um cliente recém-criado, use a solicitação HTTP POST a seguir e inclua o token de autorização:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

O CUSTOMER_ID é o nome de domínio principal do cliente ou o identificador exclusivo do cliente retornado ao recuperar a conta de um cliente revendido.

Criar um plano de compromisso anual

Para assinaturas de planos de compromisso anual, nem todas as SKUs têm as mesmas configurações de renovação padrão. Recomendamos sempre transmitir renewalSettings. Crie uma assinatura de compromisso anual com 10 assentos:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
{
  "kind": "reseller#subscription",
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "ANNUAL_MONTHLY_PAY"
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  renewalSettings: {
    "renewalType": 'RENEW_CURRENT_USERS_MONTHLY_PAY'
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID"
}

Substitua:

  • CUSTOMER_ID: o nome do domínio principal do cliente ou o identificador exclusivo dele.
  • SKU_ID: o identificador exclusivo da unidade de manutenção de estoque (SKU). Para mais informações, consulte IDs de produtos e SKUs.
  • PURCHASE_ORDER_ID: um ID de pedido de compra opcional que pode ser usado para acompanhar o uso.

Uma resposta bem-sucedida retorna um status HTTP 200 e as configurações da nova assinatura para um plano de compromisso anual. ANNUAL_MONTHLY_PAY é retornado como ANNUAL em todas as respostas da API.

Confira a seguir um exemplo de resposta para um plano anual:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "my_example.com_annual_1",
  "status": "ACTIVE",
  "customerDomain": "my_example.com",
  "skuName": "Google Workspace Business Standard"
}

Criar um plano flexível

Para criar uma assinatura flexível para uma conta de cliente recém-criada, use a seguinte solicitação HTTP POST e inclua o token de autorização:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
{
  "kind": "reseller#subscription",
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "FLEXIBLE"
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 10
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID"
}

Substitua:

  • CUSTOMER_ID: o nome do domínio principal do cliente ou o identificador exclusivo dele.
  • SKU_ID: o identificador exclusivo da unidade de manutenção de estoque (SKU). Para mais informações, consulte IDs de produtos e SKUs.
  • PURCHASE_ORDER_ID: um ID de pedido de compra opcional que pode ser usado para acompanhar o uso.

Confira a seguir um exemplo de resposta de plano flexível:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 10,
    "licensedNumberOfSeats": 0
  },
  "trialSettings": {
    "isInTrial": false
  },
  "purchaseOrderId": "my_example_flex_1",
  "status": "ACTIVE",
  "customerDomain": "my_example.com",
  "skuName": "Google Workspace Business Standard"
}

Criar um teste sem custo financeiro

Para criar uma assinatura de teste sem custo financeiro de 30 dias para uma conta de cliente recém-criada, use a seguinte solicitação HTTP POST e inclua o token de autorização:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
{
  "kind": "reseller#subscription",
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "TRIAL"
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 10
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID"
}

Substitua:

  • CUSTOMER_ID: o nome do domínio principal do cliente ou o identificador exclusivo dele.
  • SKU_ID: o identificador exclusivo da unidade de manutenção de estoque (SKU). Para mais informações, consulte IDs de produtos e SKUs.
  • PURCHASE_ORDER_ID: um ID de pedido de compra opcional que pode ser usado para acompanhar o uso.

Confira a seguir um exemplo de resposta do plano de teste sem custo financeiro de 30 dias:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "TRIAL",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 10,
    "licensedNumberOfSeats": 0
  },
  "trialSettings": {
    "isInTrial": true,
    "trialEndTime": "1331648420142"
  },
  "purchaseOrderId": "my_example_trial_1",
  "status": "ACTIVE",
  "customerDomain": "my_example.com",
  "skuName": "Google Workspace Business Standard"
}

Criar uma assinatura de desconto

O Google pode fornecer um código de oferta para criar assinaturas com um desconto. Para conceder um desconto a uma assinatura, informe o código da transação na chamada insert da assinatura. Se o cliente mudar da SKU original, o desconto será removido.

Para criar uma assinatura de compromisso anual com desconto para uma conta de cliente recém-criada, use a seguinte solicitação HTTP POST e inclua o token de autorização:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
{
  "kind": "reseller#subscription",
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "ANNUAL_MONTHLY_PAY"
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  renewalSettings: {
    "renewalType": 'RENEW_CURRENT_USERS_MONTHLY_PAY'
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID",
  "dealCode": "GOOGLE_CONTRACT_DEAL_CODE"
}

Substitua:

  • CUSTOMER_ID: o nome do domínio principal do cliente ou o identificador exclusivo dele.
  • SKU_ID: o identificador exclusivo da unidade de manutenção de estoque (SKU). Para mais informações, consulte IDs de produtos e SKUs.
  • PURCHASE_ORDER_ID: um ID de pedido de compra opcional que pode ser usado para acompanhar o uso.
  • GOOGLE_CONTRACT_DEAL_CODE: um código de desconto disponível no Google.

Confira a seguir um exemplo de resposta de desconto no plano anual:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "my_example.com_annual_1",
  "status": "ACTIVE",
  "customerDomain": "my_example.com",
  "dealCode": "GOOGLE_CONTRACT_DEAL_CODE",
  "skuName": "Google Workspace Business Standard"
}

Transferir uma assinatura

Se você não tiver pedido a conta do cliente usando a operação pedir uma nova conta de cliente, use o token de transferência do cliente ao criar uma assinatura para ele.

Para criar uma assinatura para uma conta de cliente que você não pediu, use a seguinte solicitação HTTP POST:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions?customerAuthToken=TOKEN_VALUE

Substitua:

  • CUSTOMER_ID: o nome do domínio principal do cliente ou o identificador exclusivo dele.
  • TOKEN_VALUE: um token de transferência fornecido pelo cliente. Depois que o cliente gera o token, ele é válido por 30 dias.

Para mais informações sobre como os clientes recebem um token de transferência, acesse a Central de Ajuda do Google Workspace.

Para transferir a assinatura de um cliente do plano de compromisso anual, use a solicitação HTTP POST a seguir e inclua o token de autorização:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions?customerAuthToken=auth token
{
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "ANNUAL_MONTHLY_PAY"
  },
  "seats": {
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID"
}

Substitua:

  • CUSTOMER_ID: o nome do domínio principal do cliente ou o identificador exclusivo dele.
  • SKU_ID: o identificador exclusivo da unidade de manutenção de estoque (SKU). Para mais informações, consulte IDs de produtos e SKUs.
  • PURCHASE_ORDER_ID: um ID de pedido de compra opcional que pode ser usado para acompanhar o uso.

Uma resposta bem-sucedida retorna um código de status HTTP 200 e as configurações da assinatura transferida para um plano de compromisso anual:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Admin console dashboard",
  "skuName": "Google Workspace Business Standard"
}

Limitações de transferência

Se você estiver transferindo uma assinatura do Google Workspace com uma assinatura associada do Google Drive ou do Google Vault, use a operação batch para transferir todas as assinaturas com o status ACTIVE. A transferência de cada assinatura resulta em um erro.

A transferência de assinaturas suspensas só é permitida se o motivo da suspensão for PENDING_TOS_ACCEPTANCE, TRIAL_ENDED ou RENEWAL_WITH_TYPE_CANCEL.

Ao transferir uma SKU legada, subscriptions.list retorna um skuId da SKU que precisa ser transferida. O skuId da SKU que o cliente tem é retornado como transferInfo.currentLegacySkuId. Para conferir uma lista completa de skuIds e quais produtos são usados por esses planos, consulte Produtos e SKUs.

As transferências não funcionam com códigos de desconto.