REST Resource: subscriptions

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é 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 être le domaine principal ou l'identifiant unique généré par Google.
subscriptionId

string

subscriptionId est l'identifiant de l'abonnement, qui est unique pour chaque client. Il s'agit d'une propriété obligatoire. Étant donné qu'un subscriptionId change lorsqu'un abonnement est mis à jour, nous vous recommandons de ne pas utiliser cet ID comme clé pour les données persistantes. Utilisez subscriptionId comme décrit dans Récupérer tous les abonnements des revendeurs.
skuId

string

Propriété obligatoire. 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 les codes SKU disponibles dans cette version de l'API, consultez ID de produit et de SKU.
creationTime

string (int64 format)

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

string

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

object (Seats)

Il s'agit d'une propriété obligatoire. Nombre et limite de licences utilisateur dans le forfait.
renewalSettings

object (RenewalSettings)

Paramètres de renouvellement du forfait d'engagement 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 sur le bon de commande (BC) sont destinées aux revendeurs pour suivre l'utilisation de leur entreprise. Si une valeur purchaseOrderId est indiquée, elle apparaît dans les réponses de l'API et sur la facture. Cette 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. Cette valeur est utilisée si votre application cliente nécessite que le client effectue une tâche à l'aide de la page "Abonnements" de la console d'administration.
billingMethod

string

Champ en lecture seule qui renvoie le mode de facturation actuel d'un abonnement.
suspensionReasons[]

string

Champ en lecture seule contenant un énumérable de tous les motifs de suspension actuels d'un abonnement. Un abonnement peut avoir plusieurs raisons de suspension simultanées et qui se chevauchent. La valeur STATUS d'un abonnement est SUSPENDED jusqu'à ce que toutes les suspensions en attente soient supprimées.

Voici quelques options possibles:

  • PENDING_TOS_ACCEPTANCE : le client ne s'est pas connecté et n'a pas accepté les conditions d'utilisation de G Suite revendu.
  • RENEWAL_WITH_TYPE_CANCEL : l'engagement du client a pris fin et son service a été résilié à la fin de son contrat.
  • RESELLER_INITIATED : suspension manuelle déclenchée par un revendeur.
  • TRIAL_ENDED : l'essai du client a expiré sans qu'il ait sélectionné de forfait.
  • OTHER : le client est suspendu pour une raison interne à Google (par exemple, en cas d'abus).

customerDomain

string

Nom de domaine principal du client
dealCode

string

Code émis par Google (100 caractères maximum) pour bénéficier d'une remise sur les abonnements. Le code de réduction doit être inclus dans les requêtes insert pour bénéficier du tarif réduit. Cette propriété est facultative. Si vous ne saisissez rien, le prix normal s'applique.
skuName

string

Nom à afficher externe en lecture seule pour le SKU d'un produit attribué à un client dans l'abonnement. Les noms des SKU peuvent ê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 ID de produit et de 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 annuel et l'essai sans frais de 30 jours. Pour en savoir plus sur les forfaits de paiement de l'API, consultez les concepts de l'API.
plan.planName

string

La propriété planName est obligatoire. Il s'agit du nom du forfait de l'abonnement. Pour en savoir plus sur les forfaits Google, consultez les 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 : forfait d'essai sans frais de 30 jours. Un abonnement en période d'essai sera suspendu au bout du 30e jour sans frais si aucun forfait de paiement n'est attribué. Appeler changePlan permet d'attribuer un forfait à un essai, mais ne l'active pas. L'abonnement associé à un essai commencera automatiquement après le 30e jour de l'essai sans frais ou immédiatement après l'appel de startPaidService.
  • FREE : le forfait sans frais est réservé 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 comme un forfait d'engagement annuel:

  • true : le forfait de l'abonnement est un forfait annuel.
  • false : le forfait n'est pas 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 de l'intervalle d'un forfait avec engagement annuel en millisecondes au format UNIX Epoch. Consultez un exemple de convertisseur d'époque.
plan.commitmentInterval.endTime

string (int64 format)

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

object

Vous pouvez bénéficier d'un essai sans frais de 30 jours pour les forfaits modulables et les engagements annuels G Suite. Pour en savoir plus, consultez les concepts d'API.
trialSettings.isInTrial

boolean

Détermine si un abonnement bénéficie d'un essai sans frais de 30 jours:

  • true : l'abonnement est en période d'essai.
  • false : l'abonnement 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 d'époque.
transferInfo

object

Informations en lecture seule sur le transfert de l'abonnement. Pour en savoir plus, consultez Récupérer les abonnements transférables d'un client.
transferInfo.transferabilityExpirationTime

string (int64 format)

Heure à laquelle le jeton de transfert ou l'intent de transfert expirera. L'heure est exprimée en millisecondes au format epoch Unix.
transferInfo.minimumTransferableSeats

integer

Lorsque vous insérez un abonnement, il s'agit du nombre minimal de sièges 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 minimal de sièges est de 20.
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 SKU et que la ressource d'abonnement est renseignée avec le skuId du SKU recommandé pour le transfert.

Licences

Modèle JSON pour les sièges d'abonnement.

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

integer

Il s'agit d'une propriété obligatoire, exclusive aux abonnements avec des forfaits ANNUAL_MONTHLY_PAY et ANNUAL_YEARLY_PAY. Elle 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 défini, le numberOfSeats ne peut pas être réduit avant le renouvellement. La facture du revendeur est basée sur la valeur numberOfSeats, quel que soit le nombre de ces licences utilisateur attribuées.

maximumNumberOfSeats

integer

Il s'agit d'une propriété obligatoire, exclusive aux abonnements avec des forfaits FLEXIBLE ou TRIAL. Elle définit le nombre maximal d'utilisateurs disposant d'une licence 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 du compte client.

licensedNumberOfSeats

integer

Champ en lecture seule contenant le nombre actuel d'utilisateurs auxquels une licence est attribuée pour le produit défini dans skuId. La valeur de ce champ est équivalente au nombre numérique d'utilisateurs renvoyés par la méthode de l'API Enterprise License Manager: listForProductAndSku.
kind

string

Identifie la ressource en tant que paramètre de siège d'abonnement. 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 d'engagement 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 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 forfait.

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 vers un message privé.

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

 Passer immédiatement d'un abonnement d'essai sans frais de 30 jours à un abonnement à un service payant

suspend

 Suspend un abonnement actif.