Nachdem Sie ein Abo abgerufen haben, können Sie die Informationen aus der erfolgreiche Antwort auf den Status des Abos zu ändern oder das Abo aktualisieren. Auf dieser Seite geht es darum, wie Sie um ein Abo abzurufen und zu aktualisieren.
Abo abrufen
Um ein erfolgreich bestelltes oder übertragenes Abo abzurufen, verwenden Sie den
nach einer GET
HTTP-Anfrage.
GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder die primäre Domain des Kunden Name oder die eindeutige Kennung des Kunden.SUBSCRIPTION_ID
: die Abo-ID, die für jeden Kunden eindeutig sind. Sie können diesen Wert mithilfe der Methode Methode für das Abrufen aller Reseller-Abos
Dieser Vorgang enthält keine Parameter im Anfragetext.
Eine erfolgreiche Antwort gibt den HTTP-Status 200
zurück
und die Aboeinstellungen. In der folgenden Beispielantwort
Die Property isInTrial
ist false
, es sind jedoch keine vorhanden.
trialEndTime
. Das bedeutet, dass dieser Kunde noch nie in einem
30-tägiger kostenloser Testzeitraum mit diesem Tarif.
{
"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
So rufen Sie alle Abos eines bestimmten Reseller-Kunden ab, die
bestellt oder übertragen wurde, verwenden Sie die folgende GET
-HTTP-Anfrage und
Autorisierungstoken enthalten:
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 die primäre Domain des Kunden Name oder die eindeutige Kennung des Kunden.START_DATE
: das Startdatum im FormatYYYY-MM-DD
.MAX_NUMBER
: Die maximale Anzahl der zurückgegebenen Ergebnisse auf einer Antwortseite.
Dieser Vorgang enthält keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 200
und eine Liste der
Abos und Einstellungen des Kunden zu verwalten. Die Liste der Abos kann
Produkte, die in dieser Version der Reseller API nicht verwaltet werden.
Wenn Sie diesen Kunden nicht verwalten, wird der Fehler 403 "Forbidden"
angezeigt
zurückgegeben.
Alle übertragbaren Abos für einen Kunden abrufen
Um alle Abos eines Kunden abzurufen, die potenziell
an die Verwaltung des Resellers übertragen wurde, verwenden Sie die folgende GET
-HTTP-Anfrage
und das Autorisierungstoken enthalten. Die
customerId
ist erforderlich und die eindeutige Kennung des Kunden, die zurückgegeben wird, wenn
Abrufen des Kontos eines Kunden eines Resellers.
customerAuthToken
ist ein von Ihrem Kunden bereitgestelltes Übertragungstoken, das
für Ihre Reseller-ID. Sobald er vom Kunden generiert wurde, ist er gültig für
30 Tage. Weitere Informationen dazu, wie Kunden das Token generieren, finden Sie unter
Übertragen Sie Ihr Google Workspace-Konto an einen Reseller.
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 die primäre Domain des Kunden Name oder die eindeutige Kennung des Kunden.AUTH_TOKEN
: ein von Ihrem der für Ihre Reseller-ID spezifisch ist. Nachdem sie vom ist 30 Tage lang gültig. Weitere Informationen dazu, wie Kunden das Token generieren, siehe Übertragen Sie Ihr Google Workspace-Konto an einen Reseller. Wenn dieser Wert ungültig oder abgelaufen ist, gibt die API-Antwort eine403 "Forbidden"
Fehler.START_DATE
: das Startdatum im FormatYYYY-MM-DD
.MAX_NUMBER
: Die maximale Anzahl der zurückgegebenen Ergebnisse auf einer Antwortseite.
Dieser Vorgang enthält keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 200
und eine Liste der
die übertragbaren Abos des Kunden mit dem Ablaufdatum der Übertragung
und die Mindestanzahl von Plätzen, die für den Umstieg erforderlich sind. Ein Kunde
weitere Abos enthalten, 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 Batches
alle Abos zu übertragen. Übertragung der einzelnen Abos
einzelner Nutzer führt zu einem Fehler. Außerdem werden beim Batchvorgang nur
Abos mit dem Status ACTIVE
. Weitere Informationen finden Sie unter
Abo übertragen
Alle Reseller-Abos abrufen
So rufen Sie alle erfolgreich bestellten oder übertragenen
-Abos verwenden können, verwenden Sie die folgende GET
-HTTP-Anfrage und geben Sie das Autorisierungstoken an.
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER
Ersetzen Sie Folgendes:
PREFIX
: Anfang des Namens des Kunden, dessen Abos suchen.TOKEN
: Ein Token, das eine bestimmte Seite eines Ergebnisse, die der Server zurückgeben soll.MAX_NUMBER
: Die maximale Anzahl der zurückgegebenen Ergebnisse auf einer Antwortseite.
Für diesen Vorgang kann der OAuth-Lesezugriffsbereich verwendet werden. Die
customerNamePrefix
, pageToken
und maxResults
sind optionale Abfragestrings.
Im folgenden Beispiel werden alle Abos eines Resellers abgerufen, die zu Kunden, deren Namen mit „exam“ beginnen:
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
Die Aktualisierung von Google Workspace-Abos unterscheidet sich je nach Abo. Vor der Aktualisierung sollten Sie Folgendes in Betracht ziehen:
Wenn du ein Abo erstellst und der Kunde qualifiziert ist, können Sie eine 30-tägige Testversion nutzen. Sowohl die flexible als auch die jährliche Preismodelle für Zusicherungen können kostenlose 30-tägige Testversionen sein. Während des Testzeitraums können das Abrechnungsmodell des Abos in ein flexibles oder jährliches Abrechnungsmodell ändern so oft wie nötig an. Nach Ablauf des Testzeitraums und aktiv wird, werden für die Aktualisierung des Plans dieselben Regeln wie für Abos aktive Pläne. Wenn Sie ein Probeabo sofort auf ein aktiven Plan, kostenpflichtigen Dienst mit einem 30-tägigen kostenlosen Testabo starten. Weitere Informationen zur 30-tägigen Testversion und die Regeln für die Kundenqualifizierung finden Sie in der Verwaltungshilfe.
Sie können vom flexiblen Tarif auf einen Jahrestarif aktualisieren.
Ein Jahrestarif kann nicht aktualisiert werden.
Nicht alle Abos funktionieren mit allen Produkten. Weitere Informationen dazu, Produkte, die von diesen Plänen verwendet werden, finden Sie unter Produkte und SKUs.
Wenn Sie einen 30-tägigen Testzeitraum oder ein Abo mit flexiblem Tarif auf ein Jahresabo umstellen möchten
für Zusicherungstarife 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 die primäre Domain des Kunden Name oder die eindeutige Kennung des Kunden.SUBSCRIPTION_ID
: die Abo-ID, die für jeden Kunden eindeutig sind. Sie können diesen Wert mithilfe der Methode Methode für das Abrufen aller Reseller-Abos
Im folgenden Beispiel wird das Abo mit der subscriptionId
mit
den Wert 123. Die customerId
lautet 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 der aktualisierte
Aboeinstellungen:
{
"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 aktualisieren
Wenn Sie ein Abo mit Jahrestarif aktualisieren, wird ein anderes Abo verwendet mehr als die Aktualisierung des Abos eines flexiblen Google Workspace-Tarifs.
Nutzerlizenzen für das Abo eines Jahrestarifs aktualisieren
Um die Nutzerlizenzeinstellungen eines Jahrestarifs zu aktualisieren, verwenden Sie Folgendes:
POST
-HTTP-Anfrage:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder die primäre Domain des Kunden Name oder die eindeutige Kennung des Kunden.SUBSCRIPTION_ID
: die Abo-ID, die für jeden Kunden eindeutig sind. Sie können diesen Wert mithilfe der Methode Methode für das Abrufen aller Reseller-Abos
Im folgenden Beispiel wird das Abo mit 123 subscriptionId
aktualisiert. Die
customerId
ist C0123456. Der Text der Anfrage unterscheidet sich je nach
Art des Plans:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats
Das Abo eines Google Workspace-Abos mit Jahrestarif verwendet diesen Anfragetext, um
die Anzahl der Nutzerlizenzen zu aktualisieren. Der Wert numberOfSeats
ist ein
gesamt. Wenn Sie z. B. zuvor zehn Nutzerlizenzen hatten und eine
Kundenbestellung für 5 neue Lizenzen, die Summe im Text der Anfrage für
numberOfSeats
ist 15, wie im folgenden Beispiel gezeigt:
{
"kind": "subscriptions#seats",
"numberOfSeats": 15
}
Nutzerlizenzen für das Abo eines flexiblen Tarifs aktualisieren
Das Abo eines flexiblen Google Workspace-Tarifs verwendet den Anfragetext zum Aktualisieren
die Nutzerlizenzen. Der Wert maximumNumberOfSeats
ist die Summe aus
bestehenden und den neuen Lizenzen. Dies ist die maximale Anzahl von Nutzern,
Lizenzen, die über das Konto bereitgestellt werden können.
{
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15
}
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201
zurückgegeben und der aktualisierte
Einstellungen für Abolizenzen:
{
"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
Wenn Sie die Verlängerungseinstellungen eines Abos mit Jahrestarif aktualisieren möchten, verwenden Sie das
folgende POST
-HTTP-Anfrage:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings
Ersetzen Sie Folgendes:
CUSTOMER_ID
: Entweder die primäre Domain des Kunden Name oder die eindeutige Kennung des Kunden.SUBSCRIPTION_ID
: die Abo-ID, die für jeden Kunden eindeutig sind. Sie können diesen Wert mithilfe der Methode Methode für das Abrufen aller Reseller-Abos
Hier ein Beispiel für einen Anfragetext:
{
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}
Beim Attribut renewalType
kann es sich um einen der folgenden Werte handeln:
AUTO_RENEW_YEARLY_PAY
: Am Ende des Intervalls eines Jahrestarifs das Abo automatisch alsANNUAL_YEARLY_PAY
mit der gleichnumberOfSeats
.AUTO_RENEW_MONTHLY_PAY
: Am Ende der Laufzeit eines Jahrestarifs Intervall, automatische Verlängerung des Abonnements alsANNUAL_MONTHLY_PAY
mit derselbennumberOfSeats
.RENEW_CURRENT_USERS_YEARLY_PAY
: Am Ende der Laufzeit eines Jahrestarifs Intervall, verlängern Sie das Abo alsANNUAL_YEARLY_PAY
, verwenden Sie jedoch die Gesamtzahl der aktuell aktiven Nutzerlizenzen. Dies ist die Standardeinstellung. Einstellung für aktive Jahrestarife (jährliche Zahlung).RENEW_CURRENT_USERS_MONTHLY_PAY
: Am Ende der Laufzeit eines Jahrestarifs Intervall, verlängern Sie das Abo alsANNUAL_MONTHLY_PAY
, verwenden Sie jedoch den Gesamtzahl der aktuell aktiven Nutzerlizenzen. Dies ist die Standardeinstellung. für aktive Jahrestarife (monatliche Zahlung).RENEW_ON_PROPOSED_OFFER
: Am Ende des aktuellen Zusicherungstarifs Intervall, Verlängerung gemäß dem letzten Verlängerungsangebot mit numberOfSeats als Zahl der aktuell aktiven Nutzerlizenzen oder der vorgeschlagenen Angebotszusicherung (je nachdem, was zutrifft) höher liegen.SWITCH_TO_PAY_AS_YOU_GO
: Am Ende der Laufzeit eines Jahrestarifs , ändern Sie den Jahrestarif in einen flexiblen Tarif.CANCEL
: Am Ende des Intervalls für den Jahrestarif wird das Abo ist gesperrt. Informationen zum Aufheben einer Sperrung finden Sie in den Verwaltungshilfe.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201
zurückgegeben und der aktualisierte
Einstellungen für die Aboverlängerung:
{
"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 mit einem kostenlosen Testzeitraum starten
Wenn Sie ein 30-tägiges kostenloses Testabo sofort auf einen kostenpflichtigen Dienst umstellen möchten
Abo, wenn für den Testzeitraum bereits ein Abrechnungsmodell 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 die primäre Domain des Kunden Name oder die eindeutige Kennung des Kunden.SUBSCRIPTION_ID
: die Abo-ID, die für jeden Kunden eindeutig sind. Sie können diesen Wert mithilfe der Methode Methode für das Abrufen aller Reseller-Abos
Im folgenden Beispiel ist C0123456 als customerId
und der Wert
subscriptionId
-Wert von 123:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService
Dieser Vorgang enthält 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
Sie können während der Laufzeit kein Downgrade für das Jahresabo
ein Downgrade anhand der Verlängerungseinstellungen planen. Wir empfehlen,
um zu FLEXIBLE
zu wechseln und nach der Verlängerung ein Downgrade auszuführen.
Wenn Sie ein Abo upgraden oder downgraden möchten, erstellen Sie ein neues Abo
durch die 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 die primäre Domain des Kunden Name oder die eindeutige Kennung des Kunden.
Durch diesen Aufruf wird das vorherige Abo beendet und ein neues erstellt.
Weitere Informationen zu Upgrades und Downgrades zu den Produkten und SKUs.