Method: subscriptions.delete

Kündigt, sperrt oder überträgt ein Abo an den Direktvertrieb.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
customerId

string

Das kann entweder der primäre Domainname des Kunden oder die eindeutige Kennung des Kunden sein. Wenn sich der Domainname für einen Kunden ändert, kann der alte Domainname nicht für den Zugriff auf den Kunden verwendet werden. Die eindeutige Kennung des Kunden, die von der API zurückgegeben wird, kann jedoch immer verwendet werden. Wir empfehlen, die eindeutige Kennung gegebenenfalls in Ihren Systemen zu speichern.

subscriptionId

string

Dies ist eine erforderliche Property. Die subscriptionId ist die Abo-ID und für jeden Kunden eindeutig. Da sich subscriptionId bei der Aktualisierung eines Abos ändert, empfehlen wir, diese ID nicht als Schlüssel für persistente Daten zu verwenden. Die subscriptionId kann mit der Methode Alle Reseller-Abos abrufen ermittelt werden.

Abfrageparameter

Parameter
deletionType

enum (DeletionType)

Der Abfragestring deletionType ermöglicht die Kündigung, das Downgrade oder die Sperrung eines Abos.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Diese Nachricht repräsentiert einen beliebigen HTTP-Hauptteil. Sie sollte nur für Payload-Formate verwendet werden, die nicht als JSON dargestellt werden können, z. B. binäre Rohdaten oder eine HTML-Seite.

Diese Nachricht kann sowohl für Streaming- als auch Nicht-Streaming-API-Methoden in der Anfrage sowie in der Antwort verwendet werden.

Diese Nachricht kann als übergeordnetes Anfragefeld verwendet werden. Das ist praktisch, wenn du Parameter aus der URL- oder HTTP-Vorlage in die Anfragefelder extrahierst und auch auf die Rohdaten des HTTP-Hauptteils zugreifen möchtest.

Beispiel:

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);

}

Beispiel mit Streaming-Methoden:

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

}

Durch die Verwendung dieses Typs wird nur die Art und Weise geändert, wie der Anfrage- und Antwort-Nachrichtenkörper gehandhabt wird. Alle anderen Funktionen bleiben unverändert.

Wenn der Vorgang erfolgreich abgeschlossen wurde, ist die Antwort eine allgemeine HTTP-Antwort, deren Format von der Methode vorgegeben wird.

JSON-Darstellung
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
contentType

string

Der HTTP Content-Type-Headerwert, der den Inhaltstyp des Textes angibt.

data

string (bytes format)

Der HTTP-Anfrage-/Antworttext als Rohbinärdatei.

Ein base64-codierter String

extensions[]

object

Anwendungsspezifische Antwortmetadaten. Sie müssen in der ersten Antwort für Streaming-APIs festgelegt werden.

Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

DeletionType

Enums
deletion_type_undefined
cancel Das Abo wird sofort gekündigt. Dies gilt nicht für G Suite-Abos.
transfer_to_direct

Überträgt ein Abo direkt an Google. Der Kunde wird sofort in eine direkte Abrechnungsbeziehung mit Google weitergeleitet und erhält für kurze Zeit keine Dienstunterbrechung. Der Kunde kann die Abrechnung dann mithilfe einer Kreditkarte direkt bei Google einrichten oder an einen anderen Reseller übertragen.