Esta página foi traduzida pela API Cloud Translation.

Recuperar e atualizar uma assinatura

Depois de recuperar uma assinatura, você pode usar as informações do resposta bem-sucedida para mudar o status da assinatura ou atualizar a assinatura. Esta página foca nas diferentes maneiras que você pode recuperar e atualizar uma assinatura.

Recuperar uma assinatura

Para recuperar uma assinatura solicitada ou transferida, use o após GETsolicitação HTTP.

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

Substitua:

CUSTOMER_ID: o domínio principal do cliente ou o identificador exclusivo do cliente.
SUBSCRIPTION_ID: o identificador de assinatura que é exclusivos para cada cliente. É possível recuperar esse valor usando o método Recupere todos os métodos de assinatura de revendedor.

Esta operação não tem parâmetros no corpo da solicitação.

Uma resposta bem-sucedida retorna um status HTTP 200 e as configurações da assinatura. Na resposta de exemplo a seguir, A propriedade isInTrial está false, mas não há trialEndTime, o que significa que esse cliente nunca esteve em um Teste sem custo financeiro de 30 dias com este plano.

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "billingMethod": "ONLINE",
  "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": "RENEW_CURRENT_USERS_MONTHLY_PAY"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
  "skuName": "Google Workspace Business Standard"
}

Recuperar todas as assinaturas de um cliente

Para recuperar todas as assinaturas de um cliente revendedor específico que foram solicitado ou transferido, use a seguinte solicitação HTTP GET e incluem o token de autorização:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER

Substitua:

CUSTOMER_ID: o domínio principal do cliente ou o identificador exclusivo do cliente.
START_DATE: a data de início no formato YYYY-MM-DD.
MAX_NUMBER: o número máximo de resultados retornados. em uma página de resposta.

Esta operação não tem parâmetros no corpo da solicitação.

Uma resposta bem-sucedida retorna um código de status HTTP 200 e uma lista dos assinaturas e configurações do cliente. A lista de assinaturas pode incluir produtos que não são gerenciados nessa versão da API para revendedores.

Se você não administra a conta de cliente, o erro 403 "Forbidden" é exibido retornados.

Recuperar todas as assinaturas transferíveis de um cliente

Recuperar todas as assinaturas de um cliente que poderiam ser transferido para o gerenciamento do revendedor, use a seguinte solicitação HTTP GET e incluem o token de autorização. A customerId é obrigatório e é o identificador exclusivo do cliente retornado quando como recuperar a conta de um cliente de revenda. O customerAuthToken é um token de transferência fornecido pelo cliente que é específico do seu ID de revendedor. Uma vez gerado pelo cliente, é válido para 30 dias. Para mais informações sobre como os clientes geram o token, consulte Transfira sua conta do Google Workspace para um revendedor.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER

Substitua:

CUSTOMER_ID: o domínio principal do cliente ou o identificador exclusivo do cliente.
AUTH_TOKEN: um token de transferência fornecido pela específico para seu ID de revendedor. Depois de ser gerado pelo ele é válido por 30 dias. Para mais informações sobre como os clientes gerar o token, consulte Transfira sua conta do Google Workspace para um revendedor. Se esse valor não for válido ou tiver expirado, a resposta da API retornará um 403 "Forbidden" erro.
START_DATE: a data de início no formato YYYY-MM-DD.
MAX_NUMBER: o número máximo de resultados retornados. em uma página de resposta.

Esta operação não tem parâmetros no corpo da solicitação.

Uma resposta bem-sucedida retorna um código de status HTTP 200 e uma lista dos assinaturas transferíveis do cliente com a data de validade da transferência e o número mínimo de licenças necessárias no pedido de transferência. Um cliente pode conter assinaturas adicionais que não são transferíveis.

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "432",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1331647980142",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "maximumNumberOfSeats": 500,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183980142",
        "minimumTransferableSeats": "20"
      },
      "purchaseOrderId": "PO_890",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "140",
      "skuId": "1010020028",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183780159",
        "minimumTransferableSeats": "10"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Se você planeja transferir essas assinaturas usando o modelo transfira todas as assinaturas. Como transferir cada assinatura uma a uma resulta em erro. Além disso, a operação em lote só transfere assinaturas com um status ACTIVE. Para mais informações, consulte Transferir uma assinatura.

Recuperar todas as assinaturas de revendedor

Para recuperar todos os pedidos ou transferências de um revendedor assinaturas, use a seguinte solicitação HTTP GET e inclua o token de autorização.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER

Substitua:

PREFIX: o início do nome do cliente cujo inscrições que você está procurando.
TOKEN: um token que identifica uma página específica de resultados que o servidor deve retornar.
MAX_NUMBER: o número máximo de resultados retornados. em uma página de resposta.

Esta operação pode usar o escopo de acesso somente leitura do OAuth. A customerNamePrefix, pageToken e maxResults são strings de consulta opcionais.

O exemplo a seguir recupera todas as assinaturas de um revendedor que pertencem a Clientes com nomes que começam com "exam":

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "C0123456",
      "subscriptionId": "123",
      "skuId": "1010020028",
      "creationTime": "1331647980142",
      "billingMethod": "ONLINE",
      "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": "PO_135",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-5678",
      "subscriptionId": "1404686",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "AUTO_RENEW"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Atualizar um plano de assinatura

A atualização dos planos do Google Workspace varia de acordo com o plano. Antes de atualizar um plano, considere o seguinte:

Quando você cria uma assinatura e o cliente se qualifica, o plano de assinatura pode ser um teste de 30 dias. Tanto o plano flexível quanto o anual que os planos de pagamento de compromisso podem ser avaliações sem custo financeiro de 30 dias. Durante o teste, você pode alterar o plano de pagamento da assinatura para flexível ou anual planos de compromisso com a frequência necessária. Mas depois que o teste termina e o plano ficar ativo, a atualização do plano segue as mesmas regras assinaturas planos ativos. Para transferir imediatamente uma assinatura de teste para um plano ativo, iniciar um serviço pago de uma assinatura de teste sem custo financeiro de 30 dias; Para mais informações sobre o teste de 30 dias e regras de qualificação de clientes, consulte o Central de Ajuda de administração.
Você pode atualizar um plano flexível para um plano com contrato anual.
Não é possível atualizar um plano de compromisso anual.
Nem todos os planos funcionam com todos os produtos. Para mais informações sobre quais produtos são usados por esses planos, consulte Produtos e SKUs.

Para atualizar um plano de teste de 30 dias ou uma assinatura de plano flexível para um plano anual plano de compromisso, use a seguinte solicitação HTTP POST:

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

Substitua:

CUSTOMER_ID: o domínio principal do cliente ou o identificador exclusivo do cliente.
SUBSCRIPTION_ID: o identificador de assinatura que é exclusivos para cada cliente. É possível recuperar esse valor usando o método Recupere todos os métodos de assinatura de revendedor.

O exemplo a seguir atualiza a assinatura com o subscriptionId com um valor de 123. O customerId é C0123456.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

O corpo da solicitação tem o seguinte:

{
  "kind": "reseller#changePlanRequest",
  "planName": "ANNUAL_MONTHLY_PAY",
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  "purchaseOrderId": "123_March2012"
}

Uma resposta bem sucedida retorna um código de status HTTP 201 e retorna a versão configurações do plano de assinatura:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "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": "123_March2012",
  "status": "ACTIVE",
  "skuName": "Google Workspace Business Standard"
}

Atualizar as licenças por usuário de uma assinatura

A atualização de uma assinatura de plano de compromisso anual usa uma assinatura diferente do que atualizar a assinatura de um plano flexível do Google Workspace.

Atualizar licenças para a assinatura de um plano anual

Para atualizar as configurações de licença do usuário de uma assinatura de plano anual, use o seguinte: Solicitação HTTP POST:

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

Substitua:

CUSTOMER_ID: o domínio principal do cliente ou o identificador exclusivo do cliente.
SUBSCRIPTION_ID: o identificador de assinatura que é exclusivos para cada cliente. É possível recuperar esse valor usando o método Recupere todos os métodos de assinatura de revendedor.

O exemplo a seguir atualiza a assinatura com os 123 subscriptionId. A customerId é C0123456. O corpo da solicitação difere dependendo tipo de plano:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

A assinatura de um plano com contrato anual do Google Workspace usa esse corpo de solicitação para atualizar o número de licenças de usuário. O valor numberOfSeats é um total. Por exemplo, se você já tinha 10 licenças de usuário e tem uma pedido do cliente para cinco novas licenças, o total no corpo da solicitação de numberOfSeats é 15, conforme mostrado no exemplo a seguir:

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

Atualizar licenças para a assinatura de um plano flexível

A assinatura de um plano flexível do Google Workspace usa o corpo da solicitação para atualizar as licenças de usuário. O valor maximumNumberOfSeats é o total licenças atuais e as novas. Este é o número máximo de que a conta pode provisionar.

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

Uma resposta bem sucedida retorna um código de status HTTP 201 e o configurações de licença de assinatura:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 15,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "skuName": "Google Workspace Business Standard"
}

Atualizar as configurações de renovação de uma assinatura

Para atualizar as configurações de renovação de uma assinatura de compromisso anual, use o seguinte solicitação HTTP POST:

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

Substitua:

CUSTOMER_ID: o domínio principal do cliente ou o identificador exclusivo do cliente.
SUBSCRIPTION_ID: o identificador de assinatura que é exclusivos para cada cliente. É possível recuperar esse valor usando o método Recupere todos os métodos de assinatura de revendedor.

Veja a seguir um exemplo de corpo de solicitação:

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}

O valor da propriedade renewalType pode ser qualquer um destes:

AUTO_RENEW_YEARLY_PAY: ao final do intervalo de um plano de compromisso anual, renovar automaticamente o plano de assinatura como ANNUAL_YEARLY_PAY com o mesmo numberOfSeats.
AUTO_RENEW_MONTHLY_PAY: no final do ciclo de um plano com contrato anual renove automaticamente o plano da assinatura ANNUAL_MONTHLY_PAY com o mesmo numberOfSeats.
RENEW_CURRENT_USERS_YEARLY_PAY: no final do ciclo de um plano com contrato anual intervalo, renove o plano da assinatura como ANNUAL_YEARLY_PAY, mas use o número total de licenças de usuários ativos atuais. Esse é o padrão configuração para planos de compromisso anual ativos (pagos anualmente).
RENEW_CURRENT_USERS_MONTHLY_PAY: no final do ciclo de um plano com contrato anual intervalo, renove o plano da assinatura como ANNUAL_MONTHLY_PAY, mas use o número total de licenças de usuários ativos atuais. Esse é o padrão configuração para planos de compromisso anual ativos (pagos mensalmente).
RENEW_ON_PROPOSED_OFFER: no final do período de compromisso atual de tempo, renove na proposta de renovação mais recente com numberOfSeats como número das licenças de usuários ativos atuais ou do compromisso de oferta proposto, o que for mais alto.
SWITCH_TO_PAY_AS_YOU_GO: no final do ciclo de um plano com contrato anual altere o plano de compromisso anual para um plano flexível.
CANCEL: no final de um intervalo de plano com contrato anual, a assinatura foi suspensa. Para entender como cancelar uma suspensão, consulte o Central de Ajuda de administração.

Uma resposta bem sucedida retorna um código de status HTTP 201 e o configurações de renovação da assinatura:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Iniciar o serviço pago em uma assinatura de teste sem custo financeiro

Mover imediatamente uma assinatura de teste sem custo financeiro de 30 dias para um serviço pago assinatura, se um plano de pagamento já tiver sido configurado para o teste use a seguinte solicitação HTTP POST.

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

Substitua:

CUSTOMER_ID: o domínio principal do cliente ou o identificador exclusivo do cliente.
SUBSCRIPTION_ID: o identificador de assinatura que é exclusivos para cada cliente. É possível recuperar esse valor usando o método Recupere todos os métodos de assinatura de revendedor.

O exemplo a seguir tem "C0123456" como customerId e Valor subscriptionId de 123:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService

Esta operação não tem parâmetros no corpo da solicitação.

Uma resposta bem-sucedida retorna um código de status HTTP 201 e as configurações de assinatura atualizadas:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Fazer upgrade ou downgrade de uma assinatura

Não é possível fazer downgrade dos planos anuais no meio da vigência agendar um downgrade usando as configurações de renovação. Recomendamos que você defina configurações de renovação para mudar para FLEXIBLE e fazer downgrade após o período de renovação.

Para fazer upgrade ou downgrade de uma assinatura, crie uma nova com o skuId de que você quer fazer upgrade ou downgrade.

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

Substitua:

CUSTOMER_ID: o domínio principal do cliente ou o identificador exclusivo do cliente.

Essa chamada encerra a assinatura anterior e cria uma nova.

Encontre mais informações sobre upgrades e downgrades na página "Produtos e SKUs.