REST Resource: subscriptions

Ressource : Subscription

modèle JSON d'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é est 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 correspondre au domaine principal ou à l'identifiant unique généré par Google.
subscriptionId

string

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

string

Propriété obligatoire. Le skuId est un identifiant système unique pour le SKU d'un produit attribué à un client dans l'abonnement. Pour connaître les produits et SKU disponibles dans cette version de l'API, consultez la section Identifiants des produits 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 de licences utilisateur incluses dans le forfait.
renewalSettings

object (RenewalSettings)

Paramètres de renouvellement du forfait annuel. Pour en savoir plus, consultez les options de renouvellement disponibles dans le Centre d'aide pour les administrateurs.
purchaseOrderId

string

Cette propriété est facultative. Ces informations de bon de commande sont que les revendeurs peuvent utiliser pour le suivi de leur entreprise. Si une valeur purchaseOrderId est définie, elle apparaît dans les réponses de l'API et 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. Il est utilisé 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 contenant une énumération de tous les motifs de suspension actuels d'un abonnement. Un abonnement peut être associé à de nombreux motifs de suspension simultanés. La STATUS d'un abonnement est de 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 n'a pas accepté les conditions d'utilisation des services G Suite indirects.
  • RENEWAL_WITH_TYPE_CANCEL : l'engagement du client a pris fin et son service a été annulé à la fin de la période d'engagement.
  • RESELLER_INITIATED : suspension manuelle invoquée par un revendeur.
  • TRIAL_ENDED : l'essai du client a expiré sans qu'aucun forfait n'ait été sélectionné.
  • OTHER : le compte du client a été suspendu pour une raison interne à Google (par exemple, pour utilisation abusive ou autre).

customerDomain

string

Nom de domaine principal du client
dealCode

string

Code délivré par Google (100 caractères max.) permettant de bénéficier de tarifs réduits sur les abonnements. Le code de l'offre doit être inclus dans les requêtes insert pour bénéficier d'un tarif réduit. Cet établissement est facultatif. Le tarif standard s'applique si aucune valeur n'est spécifiée.
skuName

string

Nom à afficher externe en lecture seule pour le SKU d'un produit attribué à un client dans l'abonnement. Les noms des SKU sont susceptibles d'être modifiés à la discrétion de Google. Pour connaître les produits et SKU disponibles dans cette version de l'API, consultez la section Identifiants des produits et SKU.
plan

object

La propriété plan est obligatoire. Dans cette version de l'API, les forfaits G Suite sont le forfait modulable, le forfait avec engagement annuel et le forfait d'essai sans frais de 30 jours. Pour plus d'informations sur les forfaits de l'API, consultez la page 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 de l'API.

Les valeurs possibles sont les suivantes:

  • ANNUAL_MONTHLY_PAY : forfait annuel avec paiements mensuels.
  • ANNUAL_YEARLY_PAY : forfait annuel avec paiements annuels
  • FLEXIBLE : forfait modulable
  • TRIAL : essai sans frais de 30 jours. Un abonnement en période d'essai est suspendu après le 30e jour sans frais en cas d'absence de forfait. En appelant changePlan, vous associez un forfait à un essai, mais ce dernier n'est pas activé. Le forfait associé à l'essai commence automatiquement après le 30e jour sans frais qui lui est attribué ou immédiatement après avoir appelé le startPaidService.
  • FREE : le forfait sans frais est exclusif au SKU Cloud Identity et n'entraîne aucune facturation.

plan.isCommitmentPlan

boolean

La valeur booléenne de la propriété isCommitmentPlan identifie le forfait en tant que forfait annuel:

  • true : l'abonnement est soumis à un engagement annuel.
  • false : il ne s'agit pas d'un forfait annuel.
plan.commitmentInterval

object

Dans cette version de l'API, l'intervalle du forfait d'engagement annuel est d'un an.

plan.commitmentInterval.startTime

string (int64 format)

startTime d'intervalle d'un forfait avec engagement annuel en millisecondes au format UNIX Epoch. Consultez un exemple de convertisseur epoch.
plan.commitmentInterval.endTime

string (int64 format)

endTime d'intervalle d'un forfait avec engagement annuel en millisecondes au format UNIX Epoch. Consultez un exemple de convertisseur epoch.
trialSettings

object

L'engagement annuel et les forfaits modulables de G Suite peuvent faire l'objet d'un essai sans frais de 30 jours. Pour en savoir plus, consultez la page Concepts de l'API.
trialSettings.isInTrial

boolean

Détermine si un abonnement est en période d'essai sans frais de 30 jours ou non:

  • true : le forfait est en période 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 concernant le transfert en lecture seule pour l'abonnement. Pour en savoir plus, consultez la section Récupérer des abonnements transférables pour un client.
transferInfo.transferabilityExpirationTime

string (int64 format)

Délai d'expiration du jeton de transfert ou de l'intention de transfert. L'heure 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é dans la commande de transfert pour ce produit. Par exemple, si le client compte 20 utilisateurs, le revendeur ne peut pas passer une commande de transfert de 15 licences. Le nombre minimum est de 20 licences.
transferInfo.currentLegacySkuId

string

skuId de l'abonnement indirect en cours. Ce champ n'est renseigné que si le client dispose d'un abonnement avec un ancien SKU et si la ressource d'abonnement est renseignée avec le skuId du SKU recommandé pour le transfert.

Licences

Modèle JSON pour les licences d'abonnement.

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

integer

Cette propriété est obligatoire et réservée aux abonnements 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 ce nombre défini, la valeur de numberOfSeats ne peut pas être réduite 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 réservée aux abonnements FLEXIBLE ou TRIAL. Cette propriété définit le nombre maximal d'utilisateurs disposant d'une licence 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 numérique d'utilisateurs renvoyé par la méthode de l'API Enterprise License Manager: listForProductAndSku.
kind

string

Identifie la ressource en tant que paramètre de licence utilisateur. Valeur : subscriptions#seats

RenewalSettings

Modèle JSON pour les paramètres de renouvellement d'un abonnement.

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 disponibles 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 en tant que 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 d'un abonnement.

delete

 Résilie, 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 des abonnements gérés par le revendeur.

startPaidService

 Migrer immédiatement un abonnement d'essai sans frais de 30 jours vers un abonnement payant.

suspend

 Suspend un abonnement actif.