Cette page a été traduite par l'API Cloud Translation.

Récupérer et mettre à jour un abonnement

Après avoir récupéré un abonnement, vous pouvez utiliser les informations du de réponse positive à modifier l'état de l'abonnement ou mettre à jour l'abonnement. Cette page présente les différentes façons récupérer et mettre à jour un abonnement.

Récupérer un abonnement

Pour récupérer un abonnement commandé ou transféré, utilisez le suite à GETune requête HTTP.

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

Remplacez les éléments suivants :

CUSTOMER_ID: domaine principal du client ou l'identifiant unique du client.
SUBSCRIPTION_ID: identifiant d'abonnement uniques pour chaque client. Vous pouvez récupérer cette valeur à l'aide de la méthode Récupérer la méthode d'abonnement de tous les revendeurs

Le corps de la requête ne comporte aucun paramètre pour cette opération.

Une réponse positive renvoie l'état HTTP 200. et les paramètres de l'abonnement. Dans l'exemple de réponse suivant, le La propriété isInTrial est false, mais il n'y a pas trialEndTime, ce qui signifie que le client n'a jamais accédé à Essai sans frais de 30 jours avec ce forfait.

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

Récupérer tous les abonnements d'un client

Pour récupérer tous les abonnements d'un client revendeur spécifique ont bien été commandées ou transférées, utilisez la requête HTTP GET suivante et incluez le jeton d'autorisation:

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

Remplacez les éléments suivants :

CUSTOMER_ID: domaine principal du client ou l'identifiant unique du client.
START_DATE: date de début au format YYYY-MM-DD
MAX_NUMBER: nombre maximal de résultats renvoyés sur une page de réponse.

Le corps de la requête ne comporte aucun paramètre pour cette opération.

Une réponse réussie renvoie un code d'état HTTP 200 et une liste des les abonnements et les paramètres du client. La liste des abonnements peut inclure qui ne sont pas gérés dans cette version de l'API Reseller.

Si vous ne gérez pas ce client, une erreur 403 "Forbidden" est générée renvoyé.

Récupérer tous les abonnements transférables d'un client

Pour récupérer tous les abonnements d'un client potentiellement transféré sous la gestion du revendeur, utilisez la requête HTTP GET suivante : et inclure le jeton d'autorisation. La customerId est obligatoire. Il s'agit de l'identifiant unique du client renvoyé lorsque récupérer le compte d'un client indirect. Le customerAuthToken est un jeton de transfert fourni par votre client spécifique à votre ID de revendeur. Une fois généré par le client, il est valable pendant 30 jours. Pour plus d'informations sur la manière dont les clients génèrent le jeton, voir Transférez votre compte Google Workspace à un revendeur.

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

Remplacez les éléments suivants :

CUSTOMER_ID: domaine principal du client ou l'identifiant unique du client.
AUTH_TOKEN: jeton de transfert fourni par votre client spécifique à votre identifiant de revendeur. Une fois qu'il a été généré par client, elle est valable pendant 30 jours. Pour en savoir plus sur la façon dont les clients générer le jeton, voir Transférez votre compte Google Workspace à un revendeur. Si cette valeur n'est pas valide ou a expiré, la réponse de l'API renvoie une 403 "Forbidden" erreur.
START_DATE: date de début au format YYYY-MM-DD
MAX_NUMBER: nombre maximal de résultats renvoyés sur une page de réponse.

Le corps de la requête ne comporte aucun paramètre pour cette opération.

Une réponse réussie renvoie un code d'état HTTP 200 et une liste des abonnements transférables du client avec la date d'expiration du transfert et le nombre minimal de licences utilisateur requis dans l'ordre de transfert. Un client peut contenir des abonnements supplémentaires non transférables.

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

Si vous prévoyez de transférer ces abonnements en utilisant le traitement par lot transfert de tous les abonnements. Transférer chaque abonnement une par une entraîne une erreur. De plus, l'opération par lot ne transfère abonnements avec l'état ACTIVE. Pour en savoir plus, consultez Transférer un abonnement

Récupérer tous les abonnements revendeur

Pour récupérer toutes les commandes ou transferts d'un revendeur utilisez la requête HTTP GET suivante et incluez le jeton d'autorisation.

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

Remplacez les éléments suivants :

PREFIX: début du nom du client dont les abonnements que vous recherchez.
TOKEN: jeton identifiant une page spécifique de résultats que le serveur doit renvoyer.
MAX_NUMBER: nombre maximal de résultats renvoyés sur une page de réponse.

Cette opération peut utiliser le niveau d'accès OAuth en lecture seule. La customerNamePrefix, pageToken et maxResults sont des chaînes de requête facultatives.

L'exemple suivant récupère tous les abonnements d'un revendeur appartenant à clients dont le nom commence par "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"
}

Modifier un abonnement

La mise à jour des forfaits Google Workspace diffère selon le forfait choisi. Avant la mise à jour un plan, tenez compte des points suivants:

Lorsque vous créez un abonnement et que le client remplit les conditions requises, le peut être une période d'essai de 30 jours. Les forfaits modulable et annuel Les forfaits avec engagement peuvent être des essais sans frais de 30 jours. Pendant la période d'essai, Possibilité de passer à un forfait modulable ou annuel d’engagement aussi souvent que nécessaire. Mais une fois l'essai terminé, devient actif, sa mise à jour suit les mêmes règles que les autres abonnements des plans actifs. Pour transférer immédiatement un abonnement d'essai un forfait actif, démarrer un service payant à partir d'un essai sans frais de 30 jours Pour plus d'informations sur les essais de 30 jours et sur les règles d'éligibilité des clients, consultez le Centre d'aide pour l'administration.
Vous pouvez passer d'un forfait modulable à un forfait avec engagement annuel.
Vous ne pouvez pas modifier un forfait avec engagement annuel.
Tous les forfaits ne fonctionnent pas avec tous les produits. Pour en savoir plus sur les sont utilisés par ces forfaits, consultez Produits et SKU.

Pour passer d'un forfait d'essai de 30 jours ou d'un forfait modulable à un forfait annuel utilisez la requête HTTP POST suivante:

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

Remplacez les éléments suivants :

CUSTOMER_ID: domaine principal du client ou l'identifiant unique du client.
SUBSCRIPTION_ID: identifiant d'abonnement uniques pour chaque client. Vous pouvez récupérer cette valeur à l'aide de la méthode Récupérer la méthode d'abonnement de tous les revendeurs

L'exemple suivant met à jour l'abonnement avec le subscriptionId avec une valeur de 123. Le customerId est C0123456.

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

Le corps de la requête se présente comme suit:

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

Une réponse positive renvoie un code d'état HTTP 201 et renvoie la valeur mise à jour Paramètres de l'abonnement:

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

Modifier les licences utilisateur associées à un abonnement

La mise à jour d'un abonnement avec engagement annuel utilise un abonnement différent que la mise à jour d'un abonnement à un forfait modulable Google Workspace.

Modifier les licences d'un abonnement annuel

Pour modifier les paramètres de licence utilisateur d'un abonnement annuel, utilisez le code suivant : Requête HTTP POST:

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

Remplacez les éléments suivants :

CUSTOMER_ID: domaine principal du client ou l'identifiant unique du client.
SUBSCRIPTION_ID: identifiant d'abonnement uniques pour chaque client. Vous pouvez récupérer cette valeur à l'aide de la méthode Récupérer la méthode d'abonnement de tous les revendeurs

L'exemple suivant met à jour l'abonnement avec le code subscriptionId 123. La customerId est C0123456. Le corps de la requête diffère selon type de forfait:

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

Un abonnement à un forfait avec engagement annuel Google Workspace utilise ce corps de requête pour : modifier le nombre de licences utilisateur. La valeur numberOfSeats est une total. Par exemple, si vous disposiez auparavant de 10 licences utilisateur et que vous avez commande de 5 nouvelles licences, le total indiqué dans le corps de la demande pour numberOfSeats est égal à 15, comme illustré dans l'exemple suivant:

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

Modifier les licences d'un abonnement à un forfait modulable

Un abonnement à un forfait modulable Google Workspace utilise le corps de la requête pour se mettre à jour les licences utilisateur. La valeur maximumNumberOfSeats correspond au total de licences existantes et les nouvelles licences. Il s'agit du nombre maximal d'utilisateurs licences que le compte peut provisionner.

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

Une réponse positive renvoie un code d'état HTTP 201 et la valeur mise à jour Paramètres de licence d'abonnement:

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

Mettre à jour les paramètres de renouvellement d'un abonnement

Pour mettre à jour les paramètres de renouvellement d'un abonnement avec engagement annuel, utilisez le requête HTTP POST suivante:

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

Remplacez les éléments suivants :

CUSTOMER_ID: domaine principal du client ou l'identifiant unique du client.
SUBSCRIPTION_ID: identifiant d'abonnement uniques pour chaque client. Vous pouvez récupérer cette valeur à l'aide de la méthode Récupérer la méthode d'abonnement de tous les revendeurs

Voici un exemple de corps de requête:

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

La valeur de la propriété renewalType peut être l'une des suivantes:

AUTO_RENEW_YEARLY_PAY: à la fin de l'intervalle d'un forfait avec engagement annuel, renouveler automatiquement l'abonnement en tant que ANNUAL_YEARLY_PAY avec le même numberOfSeats.
AUTO_RENEW_MONTHLY_PAY: à l'issue de la période d'engagement renouvellent automatiquement le forfait de l'abonnement ANNUAL_MONTHLY_PAY avec le même numberOfSeats.
RENEW_CURRENT_USERS_YEARLY_PAY: à l'issue de la période d'engagement renouvelez l'abonnement en tant que ANNUAL_YEARLY_PAY, mais utilisez nombre total de licences utilisateur actives en cours. Il s'agit de l'option par défaut pour les forfaits annuels actifs (paiement annuel).
RENEW_CURRENT_USERS_MONTHLY_PAY: à l'issue de la période d'engagement renouvelez l'abonnement en tant que ANNUAL_MONTHLY_PAY, mais utilisez nombre total de licences utilisateur actives en cours. Il s'agit de l'option par défaut pour les forfaits annuels actifs (paiement mensuel).
RENEW_ON_PROPOSED_OFFER: à la fin de la durée de validité du forfait le renouvellement à la dernière proposition de renouvellement en indiquant numberOfSeats comme nombre. de licences utilisateur actives actuelles ou d'engagement d'offre proposé, selon l'échéance plus élevée.
SWITCH_TO_PAY_AS_YOU_GO: à l'issue de la période d'engagement passer d'un forfait annuel à un forfait modulable.
CANCEL: à l'issue d'un intervalle d'engagement annuel, l'abonnement est suspendu. Pour savoir comment lever une suspension, consultez les Centre d'aide pour l'administration.

Une réponse positive renvoie un code d'état HTTP 201 et la valeur mise à jour Paramètres de renouvellement de l'abonnement:

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

Démarrer le service payant à partir d'un abonnement d'essai sans frais

Pour transférer immédiatement un abonnement d'essai sans frais de 30 jours à un service payant abonnement, si un forfait a déjà été configuré pour l'essai utilisez la requête HTTP POST suivante.

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

Remplacez les éléments suivants :

CUSTOMER_ID: domaine principal du client ou l'identifiant unique du client.
SUBSCRIPTION_ID: identifiant d'abonnement uniques pour chaque client. Vous pouvez récupérer cette valeur à l'aide de la méthode Récupérer la méthode d'abonnement de tous les revendeurs

Dans l'exemple suivant, customerId est défini sur C0123456. Valeur subscriptionId de 123:

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

Le corps de la requête ne comporte aucun paramètre pour cette opération.

Une réponse positive renvoie un code d'état HTTP 201 et les paramètres d'abonnement mis à jour:

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

Passer à un abonnement supérieur ou inférieur

Vous ne pouvez pas passer à un forfait inférieur en cours d'année planifier un retour à une version antérieure à l'aide des paramètres de renouvellement. Nous vous recommandons de définir paramètres de renouvellement pour passer à FLEXIBLE, puis revenir à une version antérieure après la date de renouvellement.

Pour passer à un forfait supérieur ou inférieur, créez un autre abonnement. par le skuId que vous souhaitez mettre à niveau ou revenir à une version antérieure.

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

Remplacez les éléments suivants :

CUSTOMER_ID: domaine principal du client ou l'identifiant unique du client.

Cet appel met fin à l'abonnement précédent et en crée un autre.

En savoir plus sur aux passages à un niveau supérieur ou inférieur sur la page "Produits et sur la page des codes SKU.