Ressource : Subscription
Modèle JSON pour un abonnement.
Représentation JSON |
---|
{ "customerId": string, "subscriptionId": string, "skuId": string, "creationTime": string, "kind": string, "seats": { object ( |
Champs | |
---|---|
customerId |
Cette propriété sera toujours renvoyée dans une réponse en tant qu'identifiant unique généré par Google. Dans une requête, cette propriété peut être le domaine principal ou l'identifiant unique généré par Google. |
subscriptionId |
Le |
skuId |
Propriété obligatoire. |
creationTime |
La propriété |
kind |
Identifie la ressource en tant qu'abonnement. Valeur : |
seats |
Cette propriété est obligatoire. Nombre et limite des licences utilisateur du forfait. |
renewalSettings |
Paramètres de renouvellement du forfait annuel. Pour en savoir plus, consultez les options de renouvellement dans le Centre d'aide pour les administrateurs. |
purchaseOrderId |
Cette propriété est facultative. Ces informations de bon de commande sont destinées aux revendeurs pour le suivi de l'utilisation de leur entreprise. Si une valeur |
status |
Cette propriété est facultative. |
resourceUiUrl |
URL de la page "Abonnements" du client dans la console d'administration. L'URL en lecture seule est générée par le service d'API. Elle est utilisée si votre application cliente exige que le client effectue une tâche via la page "Abonnements" de la console d'administration. |
billingMethod |
Champ en lecture seule qui renvoie la méthode de facturation actuelle d'un abonnement. |
suspensionReasons[] |
Champ en lecture seule qui contient une énumération de tous les motifs de suspension actuels d'un abonnement. Un abonnement peut avoir de nombreux motifs de suspension simultanés. Le
|
customerDomain |
Nom de domaine principal du client |
dealCode |
Code émis par Google (100 caractères maximum) pour bénéficier de tarifs réduits sur les abonnements. Le code d'offre doit être inclus dans les demandes |
skuName |
Nom à afficher externe en lecture seule pour le code SKU d'un produit attribué à un client de l'abonnement. Les noms des codes SKU sont susceptibles d'être modifiés à la discrétion de Google. Pour connaître les produits et les codes SKU disponibles dans cette version de l'API, consultez la page sur les ID produit et SKU. |
plan |
La propriété |
plan.planName |
La propriété
|
plan.isCommitmentPlan |
La valeur booléenne de la propriété
|
plan.commitmentInterval |
Dans cette version de l'API, vous pouvez souscrire un forfait annuel d'un an. |
plan.commitmentInterval.startTime |
Intervalle d'engagement annuel de |
plan.commitmentInterval.endTime |
Intervalle d'engagement annuel de |
trialSettings |
Vous pouvez essayer l'abonnement annuel à G Suite et les forfaits modulables pendant 30 jours. Pour en savoir plus, consultez les concepts de l'API. |
trialSettings.isInTrial |
Détermine si un abonnement est en période d'essai offert de 30 jours:
|
trialSettings.trialEndTime |
Date de fin de l'essai. La valeur est exprimée en millisecondes au format UNIX Epoch. Consultez un exemple de convertisseur Epoch. |
transferInfo |
Informations sur le transfert en lecture seule de l'abonnement. Pour en savoir plus, consultez Récupérer des abonnements transférables pour un client. |
transferInfo.transferabilityExpirationTime |
Délai d'expiration du jeton ou de l'intention de transfert Cette durée est exprimée en millisecondes au format UNIX Epoch. |
transferInfo.minimumTransferableSeats |
Lors de l'insertion d'un abonnement, il s'agit du nombre minimal de licences indiquées dans la commande de transfert pour ce produit. Par exemple, si le client compte 20 utilisateurs, le revendeur ne peut pas commander un transfert de 15 licences. La valeur minimale est de 20 licences utilisateur. |
transferInfo.currentLegacySkuId |
|
Licences utilisateurs
Modèle JSON pour les abonnements.
Représentation JSON |
---|
{ "numberOfSeats": integer, "maximumNumberOfSeats": integer, "licensedNumberOfSeats": integer, "kind": string } |
Champs | |
---|---|
numberOfSeats |
Cette propriété obligatoire est réservée aux abonnements avec des forfaits |
maximumNumberOfSeats |
Cette propriété est obligatoire et n'est disponible que pour les abonnements avec des forfaits |
licensedNumberOfSeats |
Champ en lecture seule contenant le nombre actuel d'utilisateurs disposant d'une licence pour le produit défini dans |
kind |
Identifie la ressource en tant que paramètre d'abonnement. Valeur : |
RenewalSettings
Modèle JSON pour les paramètres de renouvellement des abonnements.
Représentation JSON |
---|
{ "renewalType": string, "kind": string } |
Champs | |
---|---|
renewalType |
Paramètres de renouvellement du forfait annuel. Pour en savoir plus, consultez les options de renouvellement dans le Centre d'aide pour les administrateurs. Lors du renouvellement d'un abonnement, la propriété |
kind |
Identifie la ressource comme paramètre de renouvellement d'abonnement. Valeur : |
Méthodes |
|
---|---|
|
Active un abonnement précédemment suspendu par le revendeur. |
|
Met à jour un abonnement. |
|
Met à jour les paramètres de renouvellement d'une licence utilisateur. |
|
Met à jour les paramètres de licence utilisateur. |
|
Annule, suspend ou transfère un abonnement direct. |
|
Récupère un abonnement spécifique. |
|
Crée ou transfère un abonnement. |
|
Listes d'abonnements gérés par le revendeur. |
|
Convertir immédiatement un abonnement d'essai offert de 30 jours en abonnement de service payant. |
|
Suspendre un abonnement actif |