Method: subscriptions.changePlan

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

La procédure de mise à jour d'un forfait varie selon le forfait et les produits. Pour en savoir plus, consultez la description de la section 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, vous ne pouvez plus utiliser l'ancien nom de domaine pour accéder au client, mais vous pouvez toujours utiliser son identifiant unique (tel que renvoyé par l'API). Nous vous recommandons de stocker l'identifiant unique dans vos systèmes, le cas échéant.

subscriptionId

string

Il s'agit d'une propriété obligatoire. subscriptionId est l'identifiant de l'abonnement, qui est unique pour chaque client. É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. Vous pouvez trouver subscriptionId à l'aide de la méthode Récupérer tous les abonnements du 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 d'autorisation.

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 demande de changement de forfait. Valeur : subscriptions#changePlanRequest

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 de paiement Google, consultez la section 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

seats

object (Seats)

Il s'agit d'une propriété obligatoire. La propriété "seats" correspond au nombre de licences utilisateur.

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.

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 la requête changePlan pour bénéficier du tarif réduit. Cette propriété est facultative. Si un code promotionnel a déjà été ajouté à un abonnement, vous pouvez laisser cette propriété vide. Le tarif réduit existant s'appliquera toujours (si elle n'est pas vide, indiquez uniquement le code promotionnel déjà présent sur l'abonnement). Si aucun code promotionnel n'a jamais été ajouté à un abonnement et que cette propriété est laissée vide, le prix normal s'applique.