Nachdem du ein Abo abgerufen hast, kannst du die Informationen aus der erfolgreichen Antwort verwenden, um den Status des Abos zu ändern oder das Abo zu aktualisieren. Auf dieser Seite werden die verschiedenen Möglichkeiten zum Abrufen und Aktualisieren eines Abos beschrieben.
Abo abrufen
Mit der folgenden GET
-HTTP-Anfrage können Sie ein erfolgreich bestelltes oder übertragenes Abo abrufen.
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 „Alle Reseller-Abos abrufen“ abrufen.
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 200
und die Aboeinstellungen zurückgegeben. In der folgenden Beispielantwort hat die Property isInTrial
den Wert false
, aber es ist keine trialEndTime
-Property vorhanden. Das bedeutet, dass dieser Kunde noch nie in einem 30-tägigen kostenlosen Testzeitraum mit diesem Tarif war.
{
"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 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 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 werden der HTTP-Statuscode 200
und eine Liste der Abos und Einstellungen des Kunden zurückgegeben. Die Liste der Abos enthält möglicherweise Produkte, 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
Verwenden Sie die folgende GET
-HTTP-Anfrage und fügen Sie das Autorisierungstoken hinzu, um alle Abos eines Kunden abzurufen, die potenziell an die Verwaltung des Resellers übertragen werden könnten. Die customerId
ist erforderlich und ist die eindeutige Kennung des Kunden, die beim Abrufen des Kontos eines Kunden eines Resellers zurückgegeben wird.
Das customerAuthToken
ist ein von Ihrem Kunden bereitgestelltes Übertragungstoken für Ihre Reseller-ID. Nach der Generierung vom 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 die eindeutige Kennung des Kunden.AUTH_TOKEN
: Ein von Ihrem Kunden bereitgestelltes Übertragungstoken, das für Ihre Reseller-ID eindeutig ist. Nachdem sie vom Kunden generiert wurde, 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. Wenn dieser Wert ungültig 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 werden der HTTP-Statuscode 200
und eine Liste der übertragbaren Abos des Kunden mit dem Ablaufdatum des Übertragungstokens und der Mindestanzahl von Lizenzen zurückgegeben, die für die Übertragungsreihenfolge erforderlich sind. 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 per Batchvorgang übertragen möchten, übertragen Sie alle Abos. Wenn jedes Abo einzeln übertragen wird, tritt ein Fehler auf. Außerdem werden beim Batchvorgang nur Abos mit dem Status ACTIVE
übertragen. Weitere Informationen findest du unter Abo übertragen.
Alle Reseller-Abos abrufen
Wenn Sie alle erfolgreich bestellten oder übertragenen Abos eines Resellers abrufen möchten, verwenden Sie die folgende GET
-HTTP-Anfrage und fügen Sie das Autorisierungstoken hinzu.
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-Lesezugriffsbereich 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 eines 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 ein 30-tägiger Testzeitraum sein. Sowohl beim flexiblen Preismodell als auch beim Jahrestarif kann es sich um 30-tägige kostenlose Testzeiträume handeln. Während des Testzeitraums können Sie das Abrechnungsmodell des Abos beliebig oft in einen flexiblen Tarif oder einen Jahrestarif ändern. Nach Ablauf des Testzeitraums und der Aktivierung des Tarifs gelten für die Aktualisierung des Tarifs jedoch dieselben Regeln wie für die aktiven Tarife anderer Abos. Um ein Probeabo sofort in einen aktiven Tarif umzuwandeln, starten Sie einen kostenpflichtigen Dienst über ein 30-tägiges kostenloses Probeabo. Weitere Informationen zur 30-tägigen Testversion und zu den Regeln für die Kundenqualifikation finden Sie in der Hilfe für Administratoren.
Sie können einen flexiblen Tarif in einen Jahrestarif umwandeln.
Jahrestarife können nicht aktualisiert werden.
Nicht alle Abos funktionieren mit allen Produkten. Weitere Informationen dazu, welche Produkte in diesen Plänen verwendet werden, finden Sie unter Produkte und SKUs.
Verwenden Sie die folgende POST
-HTTP-Anfrage, um einen Tarif für einen 30-tägigen Testzeitraum oder einen Tarif mit flexiblem Tarif auf einen Jahrestarif zu aktualisieren:
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 „Alle Reseller-Abos abrufen“ abrufen.
Im folgenden Beispiel wird das Abo mit dem subscriptionId
auf den Wert 123 aktualisiert. 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 werden der HTTP-Statuscode 201
sowie 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"
}
Nutzerlizenzen eines Abos aktualisieren
Beim Aktualisieren eines Abos mit Jahrestarif werden andere Aboeigenschaften verwendet als beim Aktualisieren des Abos eines flexiblen Google Workspace-Abos.
Nutzerlizenzen für das Abo eines Jahrestarifs aktualisieren
Verwenden Sie die folgende POST
-HTTP-Anfrage, um die Nutzerlizenzeinstellungen eines Jahresabos 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 „Alle Reseller-Abos abrufen“ abrufen.
Im folgenden Beispiel wird das Abo mit 123 subscriptionId
aktualisiert. customerId
ist C0123456. Der Text der Anfrage variiert je nach Tariftyp:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats
Beim Abo eines Google Workspace-Jahrestarifs 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 einen Kundenauftrag für 5 neue Lizenzen haben, beträgt die Gesamtsumme im Text der Anfrage für numberOfSeats
15, wie im folgenden Beispiel gezeigt:
{
"kind": "subscriptions#seats",
"numberOfSeats": 15
}
Nutzerlizenzen für das Abo eines flexiblen Tarifs aktualisieren
Beim Abo eines flexiblen Google Workspace-Abos wird der Anfragetext verwendet, um die Nutzerlizenzen zu aktualisieren. Der Wert maximumNumberOfSeats
ist die Gesamtzahl der vorhandenen und der neuen Lizenzen. Dies ist die maximale Anzahl von Nutzerlizenzen, die mit dem Konto bereitgestellt werden können.
{
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15
}
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 201
und die aktualisierten Lizenzeinstellungen für das Abo 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 für ein Abo 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-ID, die für jeden Kunden eindeutig ist. Sie können diesen Wert mit der Methode „Alle Reseller-Abos abrufen“ abrufen.
Hier ist ein Beispiel für einen Anfragetext:
{
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}
Das Attribut renewalType
kann einen der folgenden Werte haben:
AUTO_RENEW_YEARLY_PAY
: Am Ende des Intervalls eines Jahrestarifs wird das Abo automatisch mitANNUAL_YEARLY_PAY
mit derselbennumberOfSeats
verlängert.AUTO_RENEW_MONTHLY_PAY
: Am Ende der Laufzeit eines Jahrestarifs wird das Abo automatisch mitANNUAL_MONTHLY_PAY
mit derselbennumberOfSeats
verlängert.RENEW_CURRENT_USERS_YEARLY_PAY
: Am Ende des Intervalls eines Jahrestarifs wird das Abo mitANNUAL_YEARLY_PAY
verlängert, wobei die Gesamtzahl der derzeit 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 Jahrestarifs wird das Abo mitANNUAL_MONTHLY_PAY
verlängert, wobei die Gesamtzahl der derzeit aktiven Nutzerlizenzen verwendet wird. Dies ist die Standardeinstellung für aktive Jahrestarife (monatliche Zahlung).RENEW_ON_PROPOSED_OFFER
: Am Ende des Intervalls des aktuellen Zusicherungstarifs wird der letzte Verlängerungsvorschlag mit numberOfSeats als Anzahl der aktuell aktiven Nutzerlizenzen oder der vorgeschlagenen Angebotszusicherung verlängert, je nachdem, welcher Wert höher ist.SWITCH_TO_PAY_AS_YOU_GO
: Ändern Sie am Ende des Intervalls eines Jahrestarifs den Jahrestarif in einen flexiblen Tarif.CANCEL
: Am Ende eines Intervalls für die jährliche Zusicherung wird das Abo gesperrt. Informationen zum Aufheben einer Sperrung finden Sie in der Hilfe für Administratoren.
Bei einer erfolgreichen Antwort werden 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 Probeabo starten
Wenn Sie ein 30-tägiges kostenloses Probeabo sofort auf ein kostenpflichtiges Dienstabo umstellen möchten, verwenden Sie die folgende POST
-HTTP-Anfrage, wenn bereits ein Preismodell für das Probeabo eingerichtet wurde.
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 „Alle Reseller-Abos abrufen“ abrufen.
Im folgenden Beispiel ist C0123456 der customerId
und der subscriptionId
-Wert 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 werden 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
Während der Laufzeit können Sie kein Downgrade für Jahrestarife mehr durchführen und auch kein Downgrade über die Verlängerungseinstellungen planen. Wir empfehlen Ihnen, in den Verlängerungseinstellungen zu FLEXIBLE
zu wechseln und nach der Verlängerung ein Downgrade auszuführen.
Wenn Sie ein Upgrade oder Downgrade für ein Abo ausführen 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 die eindeutige Kennung des Kunden.
Durch diesen Aufruf wird das vorherige Abo beendet und ein neues erstellt.
Weitere Informationen zu Upgrades und Downgrades finden Sie auf der Seite „Produkte und SKUs“.