Method: subscriptions.delete

Résilie, suspend ou transfère un abonnement vers un message privé.

Requête HTTP

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

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.

Paramètres de requête

Paramètres
deletionType

enum (DeletionType)

La chaîne de requête deletionType permet de résilier, de passer à un forfait inférieur ou de suspendre un abonnement.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message qui représente un corps HTTP arbitraire. Il ne doit être utilisé que pour les formats de charge utile ne pouvant pas être représentés sous la forme JSON, tels que les fichiers binaires bruts ou les pages HTML.

Ce message peut aussi bien être utilisé dans les méthodes d'API de streaming que dans les autres dans la requête, ainsi que dans la réponse.

Il peut être utilisé en tant que champ de requête de niveau supérieur, ce qui est pratique si vous souhaitez extraire des paramètres de l'URL ou du modèle HTTP dans les champs de requête, et si vous souhaitez également accéder au corps HTTP brut.

Exemple :

message GetResourceRequest {
  // A unique request id.
  string requestId = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Exemple avec les méthodes de streaming :

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

L'utilisation de ce type de méthode modifie uniquement le traitement du corps des requêtes et des réponses. Toutes les autres fonctionnalités continuent à fonctionner de la même manière.

Si la requête aboutit, la réponse est une réponse HTTP générique dont le format est défini par la méthode.

Représentation JSON 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Champs
contentType

string

Valeur d'en-tête HTTP Content-Type spécifiant le type de contenu du corps de la requête.
data

string (bytes format)

Corps de la requête/réponse HTTP en tant que données binaires brutes.

Chaîne encodée en base64.
extensions[]

object

Métadonnées de réponse spécifiques à l'application. Doivent être définies dans la première réponse pour les API de streaming.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

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.

DeletionType

Enums
deletion_type_undefined
cancel Résilie l'abonnement immédiatement. Cette règle ne s'applique pas aux abonnements G Suite.
transfer_to_direct

Transfère un abonnement directement à Google.  Le client est immédiatement transféré vers une relation de facturation directe avec Google et bénéficie d'un délai court sans interruption de service. Le client peut ensuite choisir de configurer la facturation directement auprès de Google à l'aide d'une carte de crédit ou de transférer son compte vers un autre revendeur.