REST Resource: subscriptions

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ressource : Subscription

Modèle JSON pour un abonnement.

Représentation JSON
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
Champs
customerId

string

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

string

Le subscriptionId est l'identifiant d'abonnement et est propre à chaque client. Cette propriété est obligatoire. Étant donné que subscriptionId change lors de la mise à jour d'un abonnement, nous vous recommandons de ne pas utiliser cet ID comme clé pour des données persistantes. Utilisez le subscriptionId comme décrit dans la section Récupérer tous les abonnements revendeur.

skuId

string

Propriété obligatoire. skuId est un identifiant système unique pour le code SKU d'un produit attribué à un client de l'abonnement. 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.

creationTime

string (int64 format)

La propriété creationTime correspond à la date de création de l'abonnement. Elle est exprimée en millisecondes au format Epoch. Consultez un exemple de convertisseur Epoch.

kind

string

Identifie la ressource en tant qu'abonnement. Valeur : reseller#subscription

seats

object (Seats)

Cette propriété est obligatoire. Nombre et limite des licences utilisateur du forfait.

renewalSettings

object (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

string

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 purchaseOrderId est fournie, elle apparaît dans les réponses de l'API et apparaît sur la facture. La propriété accepte jusqu'à 80 caractères en texte brut.

status

string

Cette propriété est facultative.

resourceUiUrl

string

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

string

Champ en lecture seule qui renvoie la méthode de facturation actuelle d'un abonnement.

suspensionReasons[]

string

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 STATUS d'un abonnement est SUSPENDED jusqu'à ce que toutes les suspensions en attente soient levées.

Les options possibles sont les suivantes:

  • PENDING_TOS_ACCEPTANCE : le client ne s'est pas connecté et a accepté les conditions d'utilisation des services revendus de G Suite.
  • RENEWAL_WITH_TYPE_CANCEL : l'engagement du client a pris fin, et son service a été résilié à la fin de sa période de validité.
  • RESELLER_INITIATED : suspension manuelle invoquée par un revendeur.
  • TRIAL_ENDED - L'essai du client a expiré sans forfait sélectionné.
  • OTHER : le compte client est suspendu pour une raison interne à Google (abus ou autre).

customerDomain

string

Nom de domaine principal du client

dealCode

string

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 insert pour bénéficier du tarif réduit. Cette propriété est facultative. Si vous ne renseignez pas ce champ, la tarification standard s'applique.

skuName

string

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

object

La propriété plan est obligatoire. Dans cette version de l'API, vous disposez d'un forfait modulable, d'un forfait annuel et d'un essai offert de 30 jours. Pour en savoir plus sur les forfaits de l'API, consultez les concepts de l'API.

plan.planName

string

La propriété planName est obligatoire. Nom du forfait de l'abonnement. Pour en savoir plus sur les forfaits Google, consultez la page Concepts d'API.

Les valeurs possibles sont les suivantes:

  • ANNUAL_MONTHLY_PAY : forfait annuel avec paiements mensuels.
  • ANNUAL_YEARLY_PAY : forfait avec engagement annuel
  • FLEXIBLE : forfait modulable
  • TRIAL : essai offert pendant 30 jours. En l'absence d'un forfait, l'abonnement en cours d'essai sera suspendu à la fin du 30e jour offert. Si vous appelez changePlan, vous profiterez d'un forfait d'essai sans l'activer. Le forfait commencera automatiquement à l'essai au bout de 30 jours, ou immédiatement après avoir appelé startPaidService.
  • FREE : le forfait offert est exclusif au SKU Cloud Identity et n'entraîne aucune facturation.

plan.isCommitmentPlan

boolean

La valeur booléenne de la propriété isCommitmentPlan indique que le forfait est un forfait annuel:

  • true : l'abonnement est un forfait annuel.
  • false : le forfait n'est pas un forfait annuel.

plan.commitmentInterval

object

Dans cette version de l'API, vous pouvez souscrire un forfait annuel d'un an.

plan.commitmentInterval.startTime

string (int64 format)

Intervalle d'engagement annuel de startTime en millisecondes au format UNIX Epoch. Consultez un exemple de convertisseur Epoch.

plan.commitmentInterval.endTime

string (int64 format)

Intervalle d'engagement annuel de endTime en millisecondes au format UNIX Epoch. Consultez un exemple de convertisseur Epoch.

trialSettings

object

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

boolean

Détermine si un abonnement est en période d'essai offert de 30 jours:

  • true : le forfait est en cours d'essai.
  • false : le forfait n'est pas en période d'essai.

trialSettings.trialEndTime

string (int64 format)

Date de fin de l'essai. La valeur est exprimée en millisecondes au format UNIX Epoch. Consultez un exemple de convertisseur Epoch.

transferInfo

object

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

string (int64 format)

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

integer

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

string

skuId de l'abonnement revendu actuel. Ce champ n'est renseigné que lorsque le client dispose d'un abonnement avec un ancien code SKU et que la ressource d'abonnement indique le skuId du code SKU recommandé pour le transfert.

Licences utilisateurs

Modèle JSON pour les abonnements.

Représentation JSON
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Champs
numberOfSeats

integer

Cette propriété obligatoire est réservée aux abonnements avec des forfaits ANNUAL_MONTHLY_PAY et ANNUAL_YEARLY_PAY. Cette propriété définit le nombre maximal de licences pouvant être attribuées aux utilisateurs d'un abonnement. Le revendeur peut ajouter des licences, mais une fois le numberOfSeats défini, il ne peut pas être réduit avant le renouvellement. Le revendeur est facturé en fonction de la valeur numberOfSeats, quel que soit le nombre de licences utilisateur attribuées.

maximumNumberOfSeats

integer

Cette propriété est obligatoire et n'est disponible que pour les abonnements avec des forfaits FLEXIBLE ou TRIAL. Elle définit le nombre maximal d'utilisateurs autorisés autorisés pour un abonnement. Cette quantité peut être augmentée jusqu'à la limite maximale définie dans le contrat du revendeur. La quantité minimale correspond au nombre actuel d'utilisateurs dans le compte client.

licensedNumberOfSeats

integer

Champ en lecture seule contenant le nombre actuel d'utilisateurs disposant d'une licence pour le produit défini dans skuId. La valeur de ce champ correspond au nombre d'utilisateurs affiché par la méthode API Enterprise License Manager : listForProductAndSku.

kind

string

Identifie la ressource en tant que paramètre d'abonnement. Valeur : subscriptions#seats

RenewalSettings

Modèle JSON pour les paramètres de renouvellement des abonnements.

Représentation JSON
{
  "renewalType": string,
  "kind": string
}
Champs
renewalType

string

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é renewalType est obligatoire.

kind

string

Identifie la ressource comme paramètre de renouvellement d'abonnement. Valeur : subscriptions#renewalSettings

Méthodes

activate

Active un abonnement précédemment suspendu par le revendeur.

changePlan

Met à jour un abonnement.

changeRenewalSettings

Met à jour les paramètres de renouvellement d'une licence utilisateur.

changeSeats

Met à jour les paramètres de licence utilisateur.

delete

Annule, suspend ou transfère un abonnement direct.

get

Récupère un abonnement spécifique.

insert

Crée ou transfère un abonnement.

list

Listes d'abonnements gérés par le revendeur.

startPaidService

Convertir immédiatement un abonnement d'essai offert de 30 jours en abonnement de service payant.

suspend

Suspendre un abonnement actif