Nachdem Sie ein Abo abgerufen haben, können Sie die Informationen aus der erfolgreichen Antwort verwenden, um den Status des Abos zu ändern oder das Abo zu aktualisieren. Auf dieser Seite geht es um die verschiedenen Möglichkeiten, wie Sie ein Abo abrufen und aktualisieren können.
Abo abrufen
Verwende die folgende GET
-HTTP-Anfrage, um ein erfolgreich bestelltes oder übertragenes Abo abzurufen.
GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder der primäre Domainname des Kunden oder seine eindeutige Kennung.SUBSCRIPTION_ID
: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode Alle Reseller-Abos abrufen abrufen.
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der Statuscode HTTP 200
und die Einstellungen des Abos zurückgegeben. In der folgenden Beispielantwort ist das Attribut isInTrial
false
, aber es gibt kein Attribut trialEndTime
. Das bedeutet, dass dieser Kunde mit diesem Abo noch nie einen 30-tägigen kostenlosen Testzeitraum genutzt hat.
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"billingMethod": "ONLINE",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "RENEW_CURRENT_USERS_MONTHLY_PAY"
},
"purchaseOrderId": "example.com_annual_1",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
}
Alle Abos für einen Kunden abrufen
Wenn du alle Abos eines bestimmten Resellerkunden abrufen möchtest, die erfolgreich bestellt oder übertragen wurden, verwende die folgende GET
-HTTP-Anfrage und füge das Autorisierungstoken hinzu:
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder der primäre Domainname des Kunden oder seine eindeutige Kennung.START_DATE
: Das Startdatum im FormatYYYY-MM-DD
.MAX_NUMBER
: Die maximale Anzahl der Ergebnisse, die auf einer Antwortseite zurückgegeben werden.
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200
und eine Liste der Abos und Einstellungen des Kunden zurückgegeben. Die Liste der Abos kann Produkte enthalten, die in dieser Version der Reseller API nicht verwaltet werden.
Wenn Sie diesen Kunden nicht verwalten, wird der Fehler 403 "Forbidden"
zurückgegeben.
Alle übertragbaren Abos für einen Kunden abrufen
Wenn du alle Abos eines Kunden abrufen möchtest, die potenziell an die Verwaltung des Resellers übertragen werden können, verwende die folgende GET
HTTP-Anfrage und füge das Autorisierungstoken ein. customerId
ist erforderlich und ist die eindeutige Kennung des Kunden, die beim Abrufen des Kontos eines Reseller-Kunden zurückgegeben wird.
customerAuthToken
ist ein von deinem Kunden bereitgestelltes Übertragungstoken, das deiner Reseller-ID zugewiesen ist. Nach der Generierung durch den Kunden ist sie 30 Tage lang gültig. Weitere Informationen dazu, wie Kunden das Token generieren, finden Sie unter Google Workspace-Konto an einen Reseller übertragen.
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder der primäre Domainname des Kunden oder seine eindeutige Kennung.AUTH_TOKEN
: Ein von deinem Kunden bereitgestelltes Übertragungstoken, das deiner Reseller-ID zugewiesen ist. Nach der Generierung durch den Kunden ist es 30 Tage lang gültig. Weitere Informationen dazu, wie Kunden das Token generieren, finden Sie unter Google Workspace-Konto an einen Reseller übertragen. Wenn dieser Wert ungültig ist oder abgelaufen ist, gibt die API-Antwort den Fehler403 "Forbidden"
zurück.START_DATE
: Das Startdatum im FormatYYYY-MM-DD
.MAX_NUMBER
: Die maximale Anzahl der Ergebnisse, die auf einer Antwortseite zurückgegeben werden.
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200
und eine Liste der übertragbaren Abos des Kunden mit dem Ablaufdatum des Übertragungstokens und der Mindestanzahl der Plätze, die in der Übertragungsanfrage erforderlich sind, zurückgegeben. Ein Kunde hat möglicherweise zusätzliche Abos, die nicht übertragbar sind.
{
"kind": "reseller#subscriptions",
"subscriptions": [
{
"kind": "subscriptions#subscription",
"customerId": "custId-6543",
"subscriptionId": "432",
"skuId": "1010020028",
"billingMethod": "ONLINE",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10,
"maximumNumberOfSeats": 500,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"transferInfo": {
"transferabilityExpirationTime": "1333183980142",
"minimumTransferableSeats": "20"
},
"purchaseOrderId": "PO_890",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
},
{
"kind": "subscriptions#subscription",
"customerId": "custId-6543",
"subscriptionId": "140",
"skuId": "1010020028",
"creationTime": "1329389322728",
"plan": {
"planName": "FLEXIBLE",
"isCommitmentPlan": false
},
"seats": {
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 50
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false,
"trialEndTime": "1331877480016"
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"transferInfo": {
"transferabilityExpirationTime": "1333183780159",
"minimumTransferableSeats": "10"
},
"purchaseOrderId": "",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
},
],
"nextPageToken": "token"
}
Wenn Sie diese Abos mithilfe des Batch-Vorgangs übertragen möchten, übertragen Sie alle Abos. Wenn Sie jedes Abo einzeln übertragen, führt das zu einem Fehler. Außerdem werden mit dem Batchvorgang nur Abos mit dem Status ACTIVE
übertragen. Weitere Informationen finden Sie unter Abo übertragen.
Alle Reseller-Abos abrufen
Wenn du alle erfolgreich bestellten oder übertragenen Abos eines Resellers abrufen möchtest, verwende die folgende GET
-HTTP-Anfrage und füge das Autorisierungstoken ein.
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER
Ersetzen Sie Folgendes:
PREFIX
: Der Anfang des Namens des Kunden, dessen Abos du suchst.TOKEN
: Ein Token, das eine bestimmte Ergebnisseite identifiziert, die der Server zurückgeben soll.MAX_NUMBER
: Die maximale Anzahl von Ergebnissen, die auf einer Antwortseite zurückgegeben werden.
Für diesen Vorgang kann der OAuth-Zugriffsbereich „Lesezugriff“ verwendet werden. customerNamePrefix
, pageToken
und maxResults
sind optionale Abfragestrings.
Im folgenden Beispiel werden alle Abos eines Resellers abgerufen, die Kunden gehören, deren Name mit „exam“ beginnt:
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam
{
"kind": "reseller#subscriptions",
"subscriptions": [
{
"kind": "subscriptions#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"billingMethod": "ONLINE",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"purchaseOrderId": "PO_135",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
},
{
"kind": "subscriptions#subscription",
"customerId": "custId-5678",
"subscriptionId": "1404686",
"skuId": "1010020028",
"billingMethod": "ONLINE",
"creationTime": "1329389322728",
"plan": {
"planName": "FLEXIBLE",
"isCommitmentPlan": false
},
"seats": {
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 50,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false,
"trialEndTime": "1331877480016"
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "AUTO_RENEW"
},
"purchaseOrderId": "",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
},
],
"nextPageToken": "token"
}
Abo aktualisieren
Das Aktualisieren von Google Workspace-Abos unterscheidet sich je nach Abo. Bevor Sie einen Plan aktualisieren, sollten Sie Folgendes berücksichtigen:
Wenn du ein Abo erstellst und der Kunde die Voraussetzungen erfüllt, kann das Abo einen 30-tägigen Testzeitraum haben. Sowohl das flexible Preismodell als auch der Jahrestarif können mit einem 30-tägigen kostenlosen Testzeitraum angeboten werden. Während des Testzeitraums können Sie das Preismodell des Abos beliebig oft in einen flexiblen Tarif oder einen Jahrestarif umwandeln. Nach Ablauf des Testzeitraums und Aktivierung des Abos gelten für die Aktualisierung des Abos dieselben Regeln wie für aktive Abos anderer Konten. Wenn du ein Probeabo sofort in ein aktives Abo umwandeln möchtest, starte einen kostenpflichtigen Dienst über ein 30-tägiges Probeabo. Weitere Informationen zum 30-tägigen Testzeitraum und zu den Teilnahmevoraussetzungen für Kunden finden Sie in der Verwaltungshilfe.
Sie können einen flexiblen Plan in einen Plan mit jährlicher Zusicherung umwandeln.
Sie können einen Plan mit jährlicher Zusicherung nicht aktualisieren.
Nicht alle Tarife sind mit allen Produkten kompatibel. Weitere Informationen dazu, welche Produkte für diese Pläne verwendet werden, finden Sie unter Produkte und Artikelnummern.
Wenn du einen 30-tägigen Testzeitraum oder ein flexibles Abo in ein Jahresabo umwandeln möchtest, verwende die folgende POST
-HTTP-Anfrage:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder der primäre Domainname des Kunden oder seine eindeutige Kennung.SUBSCRIPTION_ID
: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode Alle Reseller-Abos abrufen abrufen.
Im folgenden Beispiel wird das Abo mit der subscriptionId
mit dem Wert 123 aktualisiert. Der customerId
ist C0123456.
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan
Der Anfragetext enthält Folgendes:
{
"kind": "reseller#changePlanRequest",
"planName": "ANNUAL_MONTHLY_PAY",
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10
},
"purchaseOrderId": "123_March2012"
}
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201
und die aktualisierten Aboeinstellungen zurückgegeben:
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"purchaseOrderId": "123_March2012",
"status": "ACTIVE",
"skuName": "Google Workspace Business Standard"
}
Plätze eines Abos aktualisieren
Für die Aktualisierung eines Abos mit Jahrestarif werden andere Aboeigenschaften verwendet als für die Aktualisierung eines Google Workspace-Abos mit flexiblem Tarif.
Plätze für ein Abo mit Jahrestarif aktualisieren
Verwende die folgende POST
-HTTP-Anfrage, um die Nutzerlizenzeinstellungen eines Jahrestarifs zu aktualisieren:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder der primäre Domainname des Kunden oder seine eindeutige Kennung.SUBSCRIPTION_ID
: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode Alle Reseller-Abos abrufen abrufen.
Im folgenden Beispiel wird das Abo mit der 123 subscriptionId
aktualisiert. Der customerId
ist C0123456. Der Inhalt der Anfrage unterscheidet sich je nach Abotyp:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats
Bei einem Google Workspace-Abo mit einer jährlichen Bindung wird mit diesem Anfragetext die Anzahl der Nutzerlizenzen aktualisiert. Der Wert für numberOfSeats
ist eine Gesamtzahl. Wenn Sie beispielsweise zuvor 10 Nutzerlizenzen hatten und eine Kundenbestellung für 5 neue Lizenzen erhalten haben, ist die Gesamtzahl im Textkörper der Anfrage für numberOfSeats
15, wie im folgenden Beispiel gezeigt:
{
"kind": "subscriptions#seats",
"numberOfSeats": 15
}
Plätze für ein Abo mit flexiblem Tarif aktualisieren
Beim Abo eines flexiblen Google Workspace-Tarifs werden die Nutzerlizenzen über den Anfragetext aktualisiert. Der Wert maximumNumberOfSeats
ist die Summe der vorhandenen Lizenzen und der neuen Lizenzen. Das ist die maximale Anzahl von Nutzerlizenzen, die über das Konto bereitgestellt werden können.
{
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15
}
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201
und die aktualisierten Abo-Lizenzeinstellungen zurückgegeben:
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"plan": {
"planName": "FLEXIBLE",
"isCommitmentPlan": false
},
"seats": {
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"skuName": "Google Workspace Business Standard"
}
Verlängerungseinstellungen eines Abos aktualisieren
Verwende die folgende POST
-HTTP-Anfrage, um die Verlängerungseinstellungen eines Jahresabos zu aktualisieren:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder der primäre Domainname des Kunden oder seine eindeutige Kennung.SUBSCRIPTION_ID
: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode Alle Reseller-Abos abrufen abrufen.
Hier ein Beispiel für den Anfragetext:
{
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}
Für die Property renewalType
sind folgende Werte zulässig:
AUTO_RENEW_YEARLY_PAY
: Am Ende des Intervalls eines Jahrestarifs wird das Abo automatisch alsANNUAL_YEARLY_PAY
mit demselbennumberOfSeats
verlängert.AUTO_RENEW_MONTHLY_PAY
: Am Ende des Intervalls eines Jahrestarifs wird das Abo automatisch alsANNUAL_MONTHLY_PAY
mit derselbennumberOfSeats
verlängert.RENEW_CURRENT_USERS_YEARLY_PAY
: Am Ende des Intervalls eines Jahrestarifs verlängern Sie das Abo alsANNUAL_YEARLY_PAY
, verwenden aber die Gesamtzahl der aktiven Nutzerlizenzen. Dies ist die Standardeinstellung für aktive Jahresmitgliedschaften (jährliche Zahlung).RENEW_CURRENT_USERS_MONTHLY_PAY
: Am Ende des Intervalls eines Jahrestarifs verlängern Sie das Abo alsANNUAL_MONTHLY_PAY
, verwenden aber die Gesamtzahl der aktiven Nutzerlizenzen. Das ist die Standardeinstellung für aktive Jahresmitgliedschaften mit monatlicher Zahlung.RENEW_ON_PROPOSED_OFFER
: Am Ende des aktuellen Bindungszeitraums verlängern Sie den Vertrag mit dem letzten Verlängerungsvorschlag, wobei „numberOfSeats“ die Anzahl der Lizenzen für aktive Nutzer oder die Anzahl der Lizenzen für das vorgeschlagene Angebot ist, je nachdem, was höher ist.SWITCH_TO_PAY_AS_YOU_GO
: Am Ende des Intervalls eines Jahrestarifs mit monatlicher Zahlung in einen flexiblen Tarif wechseln.CANCEL
: Am Ende eines Intervalls für einen Jahrestarif wird das Abo ausgesetzt. Informationen dazu, wie Sie eine Sperrung aufheben, finden Sie in der Admin-Hilfe.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201
und die aktualisierten Einstellungen für die Verlängerung des Abos zurückgegeben:
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 15,
"licensedNumberOfSeats": 15
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"skuName": "Google Workspace Business Standard"
}
Kostenpflichtigen Dienst über ein Probeabo starten
Wenn du ein 30-tägiges kostenloses Probeabo sofort in ein kostenpflichtiges Abo umwandeln möchtest und für das Probeabo bereits ein Preismodell eingerichtet wurde, verwende die folgende POST
-HTTP-Anfrage.
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder der primäre Domainname des Kunden oder seine eindeutige Kennung.SUBSCRIPTION_ID
: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode Alle Reseller-Abos abrufen abrufen.
Im folgenden Beispiel ist C0123456 customerId
und 123 ist der subscriptionId
-Wert:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201
und die aktualisierten Aboeinstellungen zurückgegeben:
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 15,
"licensedNumberOfSeats": 15
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"skuName": "Google Workspace Business Standard"
}
Abo upgraden oder downgraden
Sie können Jahrestarife nicht während der Laufzeit kündigen und auch keine Downgrades über die Verlängerungseinstellungen planen. Wir empfehlen, die Verlängerungseinstellungen so festzulegen, dass nach der Verlängerung auf FLEXIBLE
umgestellt wird.
Wenn Sie ein Abo upgraden oder downgraden möchten, erstellen Sie ein neues Abo mit der skuId
, auf die Sie ein Upgrade oder Downgrade ausführen möchten.
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder der primäre Domainname des Kunden oder seine eindeutige Kennung.
Dadurch wird das vorherige Abo beendet und ein neues erstellt.
Weitere Informationen zu Upgrades und Downgrades finden Sie auf der Seite „Produkte und SKUs“.