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 wird beschrieben, wie Sie ein Abo abrufen und aktualisieren.
Abo abrufen
Verwenden Sie 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 die eindeutige Kennung des Kunden.SUBSCRIPTION_ID: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode zum Abrufen aller Reseller-Abos abrufen.
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Einstellungen des Abos zurückgegeben. In der folgenden Beispielantwort ist das Attribut isInTrial gleich false, aber es gibt kein Attribut trialEndTime. Das bedeutet, dass dieser Kunde noch nie eine 30‑tägige kostenlose Testphase mit diesem Abo hatte.
{
"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 Sie alle Abos eines bestimmten Reseller-Kunden abrufen möchten, die erfolgreich bestellt oder übertragen wurden, verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken ein:
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&pageToken=START_DATE&maxResults=MAX_NUMBER
Ersetzen Sie Folgendes:
CUSTOMER_ID: Entweder der primäre Domainname des Kunden oder die eindeutige Kennung des Kunden.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 den Kunden nicht verwalten, wird ein 403 Forbidden-Fehler zurückgegeben.
Alle übertragbaren Abos für einen Kunden abrufen
Wenn Sie alle Abos eines Kunden abrufen möchten, die möglicherweise an den Reseller übertragen werden können, verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken ein. customerId ist erforderlich und die eindeutige Kennung des Kunden, die beim Abrufen des Kontos eines Reseller-Kunden zurückgegeben wird.
Das customerAuthToken ist ein Übertragungstoken, das Ihr Kunde bereitstellt und das spezifisch für Ihre Reseller-ID ist. Nachdem der Kunde das Token generiert hat, 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.
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 die eindeutige Kennung des Kunden.AUTH_TOKEN: Ein von Ihrem Kunden bereitgestelltes Übertragungstoken, das für Ihre Reseller-ID spezifisch ist. Nachdem der Kunde das Token generiert hat, 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, wird in der API-Antwort ein403 Forbidden-Fehler zurückgegeben.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 an benötigten Plätzen in der Übertragungsbestellung zurückgegeben. Ein Kunde hat möglicherweise zusätzliche Abos, die nicht übertragen werden können.
{
"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 mit dem Batchvorgang übertragen möchten,übertragen Sie alle Abos. Das Übertragen von Abos einzeln führt zu einem Fehler. Außerdem werden bei Batchvorgängen nur Abos mit dem Status ACTIVE übertragen. Weitere Informationen finden Sie unter Abo übertragen.
Alle Reseller-Abos abrufen
Verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken ein, um alle Abos abzurufen, die ein Reseller erfolgreich bestellt oder übertragen hat:
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 Sie suchen.TOKEN: Ein Token, das eine bestimmte Ergebnisseite identifiziert, die der Server zurückgeben soll.MAX_NUMBER: Die maximale Anzahl der Ergebnisse, die auf einer Antwortseite zurückgegeben werden.
Für diesen Vorgang kann der OAuth-Bereich mit Lesezugriff verwendet werden. customerNamePrefix, pageToken und maxResults sind optionale Abfragestrings.
Im folgenden Beispiel werden alle Abos eines Resellers abgerufen, die zu 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 Sie ein Abo erstellen und der Kunde die Voraussetzungen erfüllt, kann das Abo als 30‑tägiger Testzeitraum eingerichtet werden. Sowohl das flexible als auch das jährliche Abrechnungsmodell können 30-tägige kostenlose Testzeiträume umfassen. Während des Testzeitraums können Sie das Preismodell des Abos beliebig oft in ein flexibles oder ein Jahresabo ändern. Nach Ablauf des Testzeitraums und Aktivierung des Abos gelten für die Aktualisierung des Abos dieselben Regeln wie für aktive Abos anderer Abonnements. Wenn Sie ein Probeabo sofort in ein aktives Abo umwandeln möchten, starten Sie einen kostenpflichtigen Dienst über ein 30‑tägiges Probeabo. Weitere Informationen zum 30‑Tage-Testzeitraum und zu den Regeln für die Kundenqualifizierung finden Sie in der Admin-Hilfe.
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 für alle Produkte verfügbar. Weitere Informationen dazu, welche Produkte in diesen Plänen verwendet werden, finden Sie unter Produkte und SKUs.
Wenn Sie ein Abo mit 30-tägigem Testzeitraum oder ein Abo mit flexiblem Tarif auf ein Abo mit Jahresvertrag umstellen möchten, verwenden Sie 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 die eindeutige Kennung des Kunden.SUBSCRIPTION_ID: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode zum Abrufen aller Reseller-Abos abrufen.
Im folgenden Beispiel wird das Abo mit dem subscriptionId-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 Einstellungen für das Abo 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"
}
Sitzplätze eines Abos aktualisieren
Beim Aktualisieren eines Abos mit jährlicher Zusicherung werden andere Aboeigenschaften verwendet als beim Aktualisieren eines Abos mit flexiblem Google Workspace-Tarif.
Anzahl der Lizenzen für ein Abo mit Jahrestarif aktualisieren
Verwenden Sie die folgende POST-HTTP-Anfrage, um die Einstellungen für Nutzerlizenzen eines Jahresabo-Abos 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 die eindeutige Kennung des Kunden.SUBSCRIPTION_ID: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode zum Abrufen aller Reseller-Abos abrufen.
Im folgenden Beispiel wird das Abo mit der subscriptionId 123 aktualisiert. Der customerId ist C0123456. Der Textkörper der Anfrage unterscheidet sich je nach Tarif:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats
Bei einem Google Workspace-Jahresabo mit Mindestlaufzeit wird die Anzahl der Nutzerlizenzen mit diesem Anfragebody aktualisiert. Der numberOfSeats-Wert ist eine Summe. Wenn Sie beispielsweise zuvor 10 Nutzerlizenzen hatten und eine Kundenbestellung für 5 neue Lizenzen vorliegt, beträgt die Gesamtzahl im Anfragetext für numberOfSeats 15, wie im folgenden Beispiel gezeigt:
{
"kind": "subscriptions#seats",
"numberOfSeats": 15
}
Sitzplätze für ein Abo mit flexiblem Tarif aktualisieren
Beim flexiblen Tarif für Google Workspace werden die Nutzerlizenzen über den Anfragetext aktualisiert. Der Wert maximumNumberOfSeats ist die Summe der vorhandenen und neuen Lizenzen. Dies ist die maximale Anzahl von Nutzerlizenzen, die für das Konto bereitgestellt werden können.
{
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15
}
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201 und die aktualisierten Einstellungen für die Abo-Lizenz 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
Verwenden Sie die folgende POST-HTTP-Anfrage, um die Verlängerungseinstellungen eines Abos mit Jahresbindung 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 die eindeutige Kennung des Kunden.SUBSCRIPTION_ID: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode zum Abrufen aller Reseller-Abos abrufen.
Hier sehen Sie ein Beispiel für einen Anfragetext:
{
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}
Der Wert der renewalType-Eigenschaft kann einer der folgenden sein:
AUTO_RENEW_YEARLY_PAY: Am Ende des Zeitraums eines Jahresabos mit Zusicherung wird das Abo automatisch alsANNUAL_YEARLY_PAYmit derselbennumberOfSeatsverlängert.AUTO_RENEW_MONTHLY_PAY: Am Ende des Zeitraums eines Jahreszusicherungstarifs wird der Tarif des Abos automatisch alsANNUAL_MONTHLY_PAYmit derselbennumberOfSeatsverlängert.RENEW_CURRENT_USERS_YEARLY_PAY: Am Ende des Intervalls eines Jahresabos mit Mindestlaufzeit wird das Abo alsANNUAL_YEARLY_PAYverlängert, wobei die Gesamtzahl der aktuellen aktiven Nutzerlizenzen verwendet wird. Dies ist die Standardeinstellung für aktive Jahrestarife (jährliche Zahlung).RENEW_CURRENT_USERS_MONTHLY_PAY: Am Ende des Intervalls eines Jahresabos mit Mindestlaufzeit wird das Abo alsANNUAL_MONTHLY_PAYverlängert, wobei die Gesamtzahl der aktuellen aktiven Nutzerlizenzen verwendet wird. Dies ist die Standardeinstellung für aktive Jahresverträge mit monatlicher Zahlung.RENEW_ON_PROPOSED_OFFER: Am Ende des Intervalls des aktuellen Zusicherungsplans wird das Angebot gemäß dem neuesten Verlängerungsvorschlag verlängert. Dabei wird die höhere Anzahl von entweder der Anzahl der aktuellen aktiven Nutzerlizenzen oder der Zusicherung des vorgeschlagenen Angebots verwendet.SWITCH_TO_PAY_AS_YOU_GO: Am Ende des Intervalls eines jährlichen Zusicherungsplans wird der jährliche Zusicherungsplan in einen flexiblen Plan geändert.CANCEL: Am Ende eines Intervalls für einen Jahrestarif wird das Abo ausgesetzt. Informationen zum Aufheben einer Sperrung finden Sie in der Admin-Hilfe.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201 und die aktualisierten Einstellungen für die Aboverlängerung 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 Sie ein 30‑tägiges kostenloses Testabo sofort in ein kostenpflichtiges Abo umwandeln möchten und bereits ein Preismodell für das Testabo eingerichtet ist, verwenden Sie 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 die eindeutige Kennung des Kunden.SUBSCRIPTION_ID: Die Abo-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode zum Abrufen aller Reseller-Abos abrufen.
Im folgenden Beispiel ist C0123456 der customerId-Wert und 123 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 Abonnementeinstellungen 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 Jahresabos nicht während der Laufzeit downgraden und auch kein Downgrade über die Verlängerungseinstellungen planen. Wir empfehlen, die Verlängerungseinstellungen so festzulegen, dass auf FLEXIBLE umgestellt und nach der Verlängerung ein Downgrade durchgeführt wird.
Wenn Sie ein Abo upgraden oder downgraden möchten, erstellen Sie ein neues Abo mit dem skuId, auf das Sie upgraden oder downgraden 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 die eindeutige Kennung des Kunden.
Mit diesem Aufruf wird das vorherige Abo beendet und ein neues erstellt.
Weitere Informationen zu Upgrades und Downgrades finden Sie auf der Seite „Produkte und SKUs“.