Method: subscriptions.changePlan

Met à jour un abonnement. Utilisez cette méthode pour passer d'un forfait d'essai de 30 jours ou d'un forfait modulable à un forfait avec engagement annuel avec paiements mensuels ou annuels.

La façon dont un plan est mis à jour varie en fonction du forfait et des produits. Pour en savoir plus, consultez la description dans Gérer les abonnements.

Requête HTTP

POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Il peut s'agir du nom de domaine principal du client ou de son identifiant unique. Si le nom de domaine d'un client change, l'ancien nom de domaine ne peut pas être utilisé pour accéder au client, mais l'identifiant unique du client (tel que renvoyé par l'API) peut toujours être utilisé. Nous vous recommandons de stocker l'identifiant unique dans vos systèmes, le cas échéant.
subscriptionId

string

Cette propriété est obligatoire. subscriptionId est l'identifiant d'abonnement propre à chaque client. É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. Vous pouvez également trouver le subscriptionId à l'aide de la méthode récupérer tous les abonnements revendeur.

Corps de la requête

Le corps de la requête contient une instance de ChangePlanRequest.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Subscription.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/apps.order

Pour en savoir plus, consultez le Guide relatif aux autorisations.

ChangePlanRequest

Modèle JSON pour la requête RPC subscriptions.changePlan.

Représentation JSON 
{
  "kind": string,
  "planName": string,
  "seats": {
    object (Seats)
  },
  "purchaseOrderId": string,
  "dealCode": string
}
Champs
kind

string

Identifie la ressource en tant que requête de changement de forfait d'abonnement. Valeur : subscriptions#changePlanRequest
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 : le forfait modulable
  • TRIAL - L'essai sans frais de 30 jours

seats

object (Seats)

Cette propriété est obligatoire. La propriété "Sièges" indique le nombre de licences utilisateur.
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.
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 la demande changePlan pour bénéficier d'un tarif réduit. Cette propriété est facultative. Si un code d'offre a déjà été ajouté à un abonnement, vous pouvez laisser cette propriété vide et le tarif réduit existant s'appliquera toujours (s'il n'est pas vide, ne fournissez que le code d'offre déjà présent dans l'abonnement). Si aucun code d'offre n'a été ajouté à un abonnement et que vous n'avez pas renseigné cette propriété, le tarif standard s'applique.