Créer ou transférer un abonnement

Une fois que vous avez commandé le compte d'un client, vous pouvez créer différents abonnements :

  • Un abonnement avec engagement annuel
  • Un abonnement flexible
  • Essai sans frais de 30 jours
  • Un abonnement à prix réduit

Pour en savoir plus sur les produits utilisés par ces abonnements, consultez Produits et SKU.

Si vous n'avez pas commandé le compte de ce client, vous pouvez transférer un abonnement.

Les clients disposant de customerType = 'team' ne peuvent acheter que les éditions Essentials et Enterprise Essentials de Google Workspace. Si vous essayez de souscrire un autre abonnement Google Workspace, l'erreur Customer is not eligible to purchase this subscription s'affiche. Les clients qui souscrivent des abonnements Essentials ou basés sur l'utilisation peuvent ne pas être en mesure de gérer les forfaits avec engagement annuel et disposent d'options de mise à niveau et de rétrogradation limitées.

Créer un abonnement

Pour créer un abonnement pour le compte d'un client nouvellement créé, utilisez la requête HTTP POST suivante et incluez le jeton d'autorisation :

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

CUSTOMER_ID correspond au nom de domaine principal du client ou à son identifiant unique renvoyé lors de la récupération du compte d'un client revendu.

Créer un forfait annuel

Pour les abonnements avec forfait annuel, tous les SKU n'ont pas les mêmes paramètres de renouvellement par défaut. Nous vous recommandons de toujours transmettre renewalSettings. Créez un abonnement annuel avec engagement de 10 licences :

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"
}

Remplacez les éléments suivants :

  • CUSTOMER_ID : nom de domaine principal du client ou identifiant unique du client.
  • SKU_ID : identifiant unique de l'unité de gestion des stocks (UGS). Pour en savoir plus, consultez ID de produit et de SKU.
  • PURCHASE_ORDER_ID : ID de bon de commande facultatif que vous pouvez utiliser pour suivre l'utilisation.

Une réponse positive renvoie un état HTTP 200 et les paramètres du nouvel abonnement pour un forfait annuel. ANNUAL_MONTHLY_PAY est renvoyé sous la forme ANNUAL dans toutes les réponses de l'API.

Voici un exemple de réponse pour un forfait annuel :

{
  "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"
}

Créer un forfait flexible

Pour créer un abonnement flexible pour le compte d'un nouveau client, utilisez la requête HTTP POST suivante et incluez le jeton d'autorisation :

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"
}

Remplacez les éléments suivants :

  • CUSTOMER_ID : nom de domaine principal du client ou identifiant unique du client.
  • SKU_ID : identifiant unique de l'unité de gestion des stocks (UGS). Pour en savoir plus, consultez ID de produit et de SKU.
  • PURCHASE_ORDER_ID : ID de bon de commande facultatif que vous pouvez utiliser pour suivre l'utilisation.

Voici un exemple de réponse pour un forfait flexible :

{
  "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"
}

Créer un essai sans frais

Pour créer un abonnement d'essai sans frais de 30 jours pour le compte d'un nouveau client, utilisez la requête HTTP POST suivante et incluez le jeton d'autorisation :

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"
}

Remplacez les éléments suivants :

  • CUSTOMER_ID : nom de domaine principal du client ou identifiant unique du client.
  • SKU_ID : identifiant unique de l'unité de gestion des stocks (UGS). Pour en savoir plus, consultez ID de produit et de SKU.
  • PURCHASE_ORDER_ID : ID de bon de commande facultatif que vous pouvez utiliser pour suivre l'utilisation.

Voici un exemple de réponse pour un forfait d'essai sans frais de 30 jours :

{
  "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"
}

Créer un abonnement avec remise

Google peut fournir un code promotionnel permettant de créer des abonnements à un tarif réduit. Pour appliquer une remise à un abonnement, vous devez fournir le code d'offre dans l'appel insert de l'abonnement. Si le client change de SKU d'origine, la remise est supprimée.

Pour créer un abonnement annuel avec remise pour le compte d'un nouveau client, utilisez la requête HTTP POST suivante et incluez le jeton d'autorisation :

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"
}

Remplacez les éléments suivants :

  • CUSTOMER_ID : nom de domaine principal du client ou identifiant unique du client.
  • SKU_ID : identifiant unique de l'unité de gestion des stocks (UGS). Pour en savoir plus, consultez ID de produit et de SKU.
  • PURCHASE_ORDER_ID : ID de bon de commande facultatif que vous pouvez utiliser pour suivre l'utilisation.
  • GOOGLE_CONTRACT_DEAL_CODE : code promotionnel disponible auprès de Google.

Voici un exemple de réponse pour un forfait annuel à prix réduit :

{
  "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"
}

Transférer un abonnement

Si vous n'avez pas commandé le compte client à l'aide de l'opération order a new customer account (commander un compte client), utilisez le jeton de transfert du client lorsque vous créez un abonnement pour ce client.

Pour créer un abonnement pour un compte client que vous n'avez pas commandé, utilisez la requête HTTP POST suivante :

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

Remplacez les éléments suivants :

  • CUSTOMER_ID : nom de domaine principal du client ou identifiant unique du client.
  • TOKEN_VALUE : jeton de transfert fourni par votre client. Une fois que le client a généré le jeton, il est valable pendant 30 jours.

Pour savoir comment les clients obtiennent un jeton de transfert, consultez le Centre d'aide Google Workspace.

Pour transférer l'abonnement d'un client ayant souscrit un forfait annuel, utilisez la requête HTTP POST suivante et incluez le jeton d'autorisation :

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"
}

Remplacez les éléments suivants :

  • CUSTOMER_ID : nom de domaine principal du client ou identifiant unique du client.
  • SKU_ID : identifiant unique de l'unité de gestion des stocks (UGS). Pour en savoir plus, consultez ID de produit et de SKU.
  • PURCHASE_ORDER_ID : ID de bon de commande facultatif que vous pouvez utiliser pour suivre l'utilisation.

Une réponse réussie renvoie un code d'état HTTP 200 et les paramètres de l'abonnement transféré pour un forfait annuel :

{
  "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"
}

Limites de transfert

Si vous transférez un abonnement Google Workspace associé à un abonnement Google Drive ou Google Vault, utilisez l'opération batch pour transférer tous les abonnements dont l'état est ACTIVE. Le transfert de chaque abonnement un par un génère une erreur.

Le transfert des abonnements suspendus n'est autorisé que si le motif de la suspension est PENDING_TOS_ACCEPTANCE, TRIAL_ENDED ou RENEWAL_WITH_TYPE_CANCEL.

Lors du transfert d'un ancien SKU, subscriptions.list renvoie un skuId du SKU à transférer. Le skuId du SKU que le client possède réellement est renvoyé sous la forme transferInfo.currentLegacySkuId. Pour obtenir la liste complète des skuIds et des produits utilisés par ces forfaits, consultez Produits et SKU.

Les transferts ne fonctionnent pas avec les codes de réduction.