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 procédure de modification d'un plan 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 ou de l'identifiant unique du client. Si le nom de domaine d'un client change, l'ancien nom de domaine ne peut plus ê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 conserver l'identifiant unique dans vos systèmes, le cas échéant.

subscriptionId

string

Cette propriété est obligatoire. subscriptionId est l'identifiant d'abonnement et est unique à 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 des données persistantes. Vous pouvez également trouver l'subscriptionId en utilisant la méthode permettant de récupérer tous les abonnements des revendeurs.

Corps de la requête

Le corps de la requête contient une instance 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 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 Google, consultez Concepts de l'API.

Les valeurs possibles sont:

  • ANNUAL_MONTHLY_PAY : forfait annuel avec paiements mensuels.
  • ANNUAL_YEARLY_PAY : forfait avec engagement 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é "licences" indique le nombre de licences utilisateur.

purchaseOrderId

string

Cette propriété est facultative. Les informations de bon de commande permettent aux revendeurs de les utiliser pour le suivi de l'utilisation faite par leur entreprise. Si une valeur purchaseOrderId est spécifiée, 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 émis 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 du 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, fournissez uniquement le code d'offre déjà présent dans l'abonnement). Si aucun code d'offre n'a été ajouté à un abonnement et que cette propriété n'est pas renseignée, le tarif standard s'applique.