Method: subscriptions.suspend

Suspend un abonnement actif.

Vous pouvez utiliser cette méthode pour suspendre un abonnement payant qui est actuellement dans l'état ACTIVE.

  • Pour les abonnements FLEXIBLE, la facturation est suspendue.
  • Pour les abonnements ANNUAL_MONTHLY_PAY ou ANNUAL_YEARLY_PAY :
    • La suspension de l'abonnement n'a aucune incidence sur la date de renouvellement initialement prévue.
    • Un abonnement suspendu n'est pas renouvelé.  Si vous activez l'abonnement après la date de renouvellement d'origine, un nouvel abonnement annuel sera créé à compter du jour de l'activation.

Nous vous encourageons vivement à ne suspendre les abonnements que pendant de courtes périodes, car une suspension de plus de 60 jours peut entraîner la résiliation de l'abonnement.

Requête HTTP

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

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 doit être vide.

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.