Method: subscriptions.changePlan

Aktualisiert ein Abo. Mit dieser Methode können Sie einen Tarif für einen 30-tägigen Testzeitraum oder einen flexiblen Tarif in einen Jahrestarif mit monatlichen oder jährlichen Zahlungen ändern.

Wie ein Plan aktualisiert wird, hängt vom Tarif und den Produkten ab. Weitere Informationen finden Sie in der Beschreibung unter Abos verwalten.

HTTP-Anfrage

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

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 mehr für den Zugriff auf den Kunden verwendet werden. Es kann jedoch immer die eindeutige ID des Kunden (die von der API zurückgegeben wird) 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 darf für jeden Kunden nur einmal vorkommen. Da sich subscriptionId ändert, wenn ein Abo aktualisiert wird, empfehlen wir, diese ID nicht als Schlüssel für persistente Daten zu verwenden. Die subscriptionId kann mit der Methode Alle Reseller-Abos abrufen abgerufen werden.

Anfragetext

Der Anfragetext enthält eine Instanz von ChangePlanRequest.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Subscription.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

ChangePlanRequest

JSON-Vorlage für die RPC-Anfrage "subscriptions.changePlan".

JSON-Darstellung
{
  "kind": string,
  "planName": string,
  "seats": {
    object (Seats)
  },
  "purchaseOrderId": string,
  "dealCode": string
}
Felder
kind

string

Gibt die Ressource als Anfrage zur Aboänderung an. Wert: subscriptions#changePlanRequest

planName

string

Das Attribut planName ist erforderlich. Dies ist der Name des Preismodells für das Abo. Weitere Informationen zu den Preismodellen von Google finden Sie unter API-Konzepte.

Mögliche Werte sind:

  • ANNUAL_MONTHLY_PAY: Jahrestarif mit monatlichen Zahlungen
  • ANNUAL_YEARLY_PAY: Jahrestarif mit jährlichen Zahlungen
  • FLEXIBLE – Der flexible Tarif
  • TRIAL – 30-tägiger kostenloser Testzeitraum

seats

object (Seats)

Dies ist eine erforderliche Property. Das Attribut „Sitze“ gibt die Anzahl der Nutzerlizenzen an.

purchaseOrderId

string

Dies ist eine optionale Eigenschaft. Diese Auftragsinformationen können Reseller zur Nachverfolgung der Nutzung in ihrem Unternehmen verwenden. Wenn ein purchaseOrderId-Wert angegeben ist, erscheint er in den API-Antworten und in der Rechnung. Die Eigenschaft akzeptiert bis zu 80 Textzeichen.

dealCode

string

Von Google ausgestellter Code (max. 100 Zeichen) für den Rabatt auf Abos. Der Deal-Code muss in der changePlan-Anfrage enthalten sein, um den Rabatt zu erhalten. Dieses Attribut ist optional. Wenn einem Abo bereits ein Deal-Code hinzugefügt wurde, kann diese Property leer bleiben und der vorhandene Rabattpreis gilt weiterhin. Falls nicht, geben Sie nur den Deal-Code an, der für das Abo bereits vorhanden ist. Wenn einem Abo noch kein Dealcode hinzugefügt wurde und dieses Attribut leer gelassen wird, gelten die regulären Preise.