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-Kennung, 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 HTTP-Statuscode 200 und die Einstellungen des Abos zurückgegeben. In der folgenden Beispielantwort ist die Property isInTrial auf false gesetzt, aber es gibt keine Property trialEndTime. Das bedeutet, dass dieser Kunde diesen Tarif noch nie im Rahmen eines 30-tägigen kostenlosen Testzeitraums 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
Verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken ein, um alle Abos eines bestimmten Reseller-Kunden abzurufen, die erfolgreich bestellt oder übertragen wurden:
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 der Fehler 403 Forbidden zurückgegeben.
Alle übertragbaren Abos für einen Kunden abrufen
Verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken ein, um alle Abos eines Kunden abzurufen, die möglicherweise an den Reseller übertragen werden können. Der customerId ist erforderlich
und ist die eindeutige Kennung des Kunden, die beim
Abrufen des Kontos eines weiterverkauften Kunden zurückgegeben wird.
customerAuthToken ist ein Übertragungstoken, das von Ihrem Kunden bereitgestellt wird und spezifisch für Ihre Reseller-ID ist. Nachdem der Kunde das Token generiert hat, ist es 30 Tage lang gültig. Weitere Informationen zum Generieren des
Tokens durch Kunden 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 Übertragungstoken, das von Ihrem Kunden bereitgestellt wird und spezifisch für Ihre Reseller-ID ist. Nachdem der Kunde das Token generiert hat, ist es 30 Tage lang gültig. Weitere Informationen zum Generieren des Tokens durch Kunden finden Sie unter Google Workspace-Konto an einen Reseller übertragen. Wenn dieser Wert ungültig ist oder abgelaufen ist, wird in der API-Antwort der Fehler403 Forbiddenzurü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 der für die Übertragungsbestellung erforderlichen Nutzerlizenzen zurückgegeben. Ein Kunde kann zusätzliche Abos haben, 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 mit dem Batchvorgang übertragen möchten,übertragen Sie alle Abos. Das Übertragen von Abos einzeln führt 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
Verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken ein, um alle erfolgreich bestellten oder übertragenen Abos eines Resellers abzurufen:
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 schreibgeschützte OAuth-Zugriffsbereich 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 ein Abo aktualisieren, sollten Sie Folgendes berücksichtigen:
Wenn Sie ein Abo erstellen und der Kunde die Voraussetzungen erfüllt, kann das Abo ein 30-tägiger Testzeitraum sein. Sowohl der flexible Tarif als auch der Jahrestarif können 30 Tage lang kostenlos getestet werden. Während des Testzeitraums können Sie das Preismodell des Abos beliebig oft in einen flexiblen Tarif oder einen Jahrestarif ändern. Nach Ablauf des Testzeitraums und der Aktivierung des Abos gelten für das Aktualisieren des Abos dieselben Regeln wie für aktive Abos anderer Abos. Wenn Sie ein Test abo sofort in ein aktives Abo umwandeln möchten, starten Sie einen kostenpflichtigen Dienst über ein 30-tägiges kostenloses Testabo. Weitere Informationen zum 30-tägigen Testzeitraum und zu den Regeln für die Kundenqualifizierung finden Sie unter der Google Workspace-Admin-Hilfe.
Sie können ein Abo mit flexiblem Tarif in ein Abo mit Jahrestarif umwandeln.
Ein Abo mit Jahrestarif kann nicht aktualisiert werden.
Nicht alle Tarife funktionieren mit allen Produkten. Weitere Informationen zu den Produkten, die von diesen Tarifen verwendet werden, finden Sie unter Produkte und SKUs.
Verwenden Sie die folgende POST-HTTP-Anfrage, um ein Abo mit 30-tägigem Testzeitraum oder flexiblem Tarif in ein Abo mit Jahrestarif umzuwandeln:
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-Kennung, 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 dem Wert subscriptionId 123 aktualisiert. Die 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"
}
Anzahl der Nutzerlizenzen eines Abos ändern
Beim Aktualisieren eines Abos mit Jahrestarif werden andere Abo-Properties verwendet als beim Aktualisieren eines Google Workspace-Abos mit flexiblem Tarif.
Anzahl der Nutzerlizenzen für ein Abo mit Jahrestarif ändern
Verwenden Sie die folgende POST-HTTP-Anfrage, um die Einstellungen für die Nutzerlizenzen eines Abos mit Jahrestarif 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-Kennung, 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 123 aktualisiert. Die customerId ist C0123456. Der Anfragetext unterscheidet sich je nach Tarif:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats
Für ein Google Workspace-Abo mit Jahrestarif wird dieser Anfragetext verwendet, um die Anzahl der Nutzerlizenzen zu aktualisieren. Der Wert numberOfSeats ist eine Summe. Wenn Sie beispielsweise zuvor 10 Nutzerlizenzen hatten und ein Kunde 5 neue Lizenzen bestellt hat, beträgt die Summe im Anfragetext für numberOfSeats 15, wie im folgenden Beispiel gezeigt:
{
"kind": "subscriptions#seats",
"numberOfSeats": 15
}
Anzahl der Nutzerlizenzen für ein Abo mit flexiblem Tarif ändern
Für ein Google Workspace-Abo mit flexiblem Tarif wird der Anfragetext verwendet, um die Nutzerlizenzen zu aktualisieren. 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 Jahrestarif 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-Kennung, 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 einen Anfragetext:
{
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}
Für die Property renewalType kann einer der folgenden Werte angegeben werden:
AUTO_RENEW_YEARLY_PAY: Am Ende des Intervalls eines Abos mit Jahrestarif wird das Abo automatisch alsANNUAL_YEARLY_PAYmit derselbennumberOfSeatsverlängert.AUTO_RENEW_MONTHLY_PAY: Am Ende des Intervalls eines Abos mit Jahrestarif wird das Abo automatisch alsANNUAL_MONTHLY_PAYmit derselbennumberOfSeatsverlängert.RENEW_CURRENT_USERS_YEARLY_PAY: Am Ende des Intervalls eines Abos mit Jahrestarif wird das Abo alsANNUAL_YEARLY_PAYverlängert, aber die Gesamtzahl der aktuellen aktiven Nutzerlizenzen wird verwendet. Dies ist die Standardeinstellung für aktive Abos mit Jahrestarif (jährliche Zahlung).RENEW_CURRENT_USERS_MONTHLY_PAY: Am Ende des Intervalls eines Abos mit Jahrestarif wird das Abo alsANNUAL_MONTHLY_PAYverlängert, aber die Gesamtzahl der aktuellen aktiven Nutzerlizenzen wird verwendet. Dies ist die Standardeinstellung für aktive Abos mit Jahrestarif (monatliche Zahlung).RENEW_ON_PROPOSED_OFFER: Am Ende des Intervalls des aktuellen Abos wird das Abo mit dem neuesten Verlängerungsvorschlag verlängert. Dabei wird die Anzahl der aktuellen aktiven Nutzerlizenzen oder die Anzahl der Nutzerlizenzen des vorgeschlagenen Angebots verwendet, je nachdem, welcher Wert höher ist.SWITCH_TO_PAY_AS_YOU_GO: Am Ende des Intervalls eines Abos mit Jahrestarif wird das Abo mit Jahrestarif in ein Abo mit flexiblem Tarif umgewandelt.CANCEL: Am Ende des Intervalls eines Abos mit Jahrestarif wird das Abo gesperrt. Informationen zum Aufheben einer Sperrung finden Sie in der Google Workspace-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 kostenloses Testabo 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 wurde, 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-Kennung, 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 die customerId und der Wert für subscriptionId ist 123:
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
Abos mit Jahrestarif können nicht während der Laufzeit downgradet werden. Außerdem kann ein Downgrade nicht über die Verlängerungseinstellungen geplant werden. Wir empfehlen, die Verlängerungseinstellungen so zu konfigurieren, dass zu FLEXIBLE gewechselt wird, und dann nach der Verlängerung ein Downgrade durchzuführen.
Wenn Sie ein Abo upgraden oder downgraden möchten, erstellen Sie ein neues Abo mit der skuId, auf die 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.