Po pobraniu subskrypcji możesz użyć informacji z udana odpowiedź na zmień stan subskrypcji lub zaktualizować subskrypcję. Na tej stronie omawiamy różne możliwości pobierania i aktualizowania subskrypcji.
Odzyskiwanie subskrypcji
Aby odzyskać zamówioną lub przeniesioną subskrypcję, użyj
po GETżądaniu HTTP.
GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID
Zastąp następujące elementy:
CUSTOMER_ID: domena podstawowa klienta. nazwę użytkownika lub unikalny identyfikator klienta.SUBSCRIPTION_ID: identyfikator subskrypcji, którym jest i niepowtarzalna. Tę wartość możesz pobrać za pomocą Pobieranie wszystkich metod subskrypcji sprzedawcy
Ta operacja nie ma parametrów w treści żądania.
Pomyślna odpowiedź zwraca stan HTTP 200.
kod i ustawienia subskrypcji. W poniższej przykładowej odpowiedzi
Właściwość isInTrial ma wartość false, ale nie ma
trialEndTime, co oznacza, że ten klient nigdy nie był
30-dniowy bezpłatny okres próbny dla tego abonamentu.
{
"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"
}
Pobierz wszystkie subskrypcje klienta
Aby pobrać wszystkie subskrypcje określonego klienta sprzedawcy, które zostały
zostało zamówione lub przesłane, użyj następującego żądania HTTP GET i
dołącz token autoryzacji:
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER
Zastąp następujące elementy:
CUSTOMER_ID: domena podstawowa klienta. nazwę użytkownika lub unikalny identyfikator klienta.START_DATE: data rozpoczęcia w formacieYYYY-MM-DDMAX_NUMBER: maksymalna liczba zwróconych wyników na stronie odpowiedzi.
Ta operacja nie ma parametrów w treści żądania.
Odpowiedź pomyślna zwraca kod stanu HTTP 200 i listę funkcji
subskrypcji i ustawień klienta. Lista subskrypcji może zawierać
usługi, które nie są zarządzane w tej wersji interfejsu Seller API.
Jeśli nie zarządzasz tym klientem, który nie jest zarządzany, 403 "Forbidden" błąd to:
.
Pobierz wszystkie subskrypcje, które można przenieść dla klienta
Aby pobrać wszystkie subskrypcje klienta, które mogą zostać
przeniesione do zarządzania sprzedawcy, użyj następującego żądania HTTP GET
i dołącz token autoryzacji.
Parametr customerId jest wymagany i jest unikalnym identyfikatorem klienta zwracanym, gdy
odzyskanie konta klienta sprzedawcy.
customerAuthToken to token przeniesienia udostępniony przez klienta, który jest
identyfikatora sprzedawcy. Wygenerowany przez klienta będzie ważny przez
30 dni. Więcej informacji o tym, jak klienci generują token, znajdziesz w artykule
Przenieś konto Google Workspace do sprzedawcy.
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER
Zastąp następujące elementy:
CUSTOMER_ID: domena podstawowa klienta. nazwę użytkownika lub unikalny identyfikator klienta.AUTH_TOKEN: token przeniesienia udostępniony przez klienta powiązanego z Twoim identyfikatorem sprzedawcy. Po wygenerowaniu przez jest ważny przez 30 dni. Więcej informacji o tym, jak klienci do wygenerowania tokena, patrz sekcja Przenieś konto Google Workspace do sprzedawcy. Jeśli ta wartość jest nieprawidłowa lub straciła ważność, odpowiedź interfejsu API zwraca błąd403 "Forbidden"błąd.START_DATE: data rozpoczęcia w formacieYYYY-MM-DDMAX_NUMBER: maksymalna liczba zwróconych wyników na stronie odpowiedzi.
Ta operacja nie ma parametrów w treści żądania.
Odpowiedź pomyślna zwraca kod stanu HTTP 200 i listę funkcji
subskrypcje klienta, które można przenieść, z datą ważności przeniesienia
token i minimalną liczbę stanowisk potrzebnych w zamówieniu przeniesienia. klienta
może zawierać dodatkowe subskrypcje, których nie można przenieść.
{
"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"
}
Jeśli planujesz przenieść te subskrypcje, korzystając z grupy
przenieś wszystkie subskrypcje. Przenoszenie każdej subskrypcji
powoduje wyświetlenie błędu. Dodatkowo operacja wsadowa jest przenoszona
subskrypcje o stanie ACTIVE. Więcej informacji:
Przenoszenie subskrypcji
Pobierz wszystkie subskrypcje sprzedawcy
Aby pobrać wszystkie zamówione lub przeniesione zasoby sprzedawcy
do subskrypcji, użyj tego żądania HTTP GET i dołącz token autoryzacji.
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER
Zastąp następujące elementy:
PREFIX: początek nazwy klienta, którego na interesujące Cię subskrypcje.TOKEN: token identyfikujący konkretną stronę który powinien zwrócić serwer.MAX_NUMBER: maksymalna liczba zwróconych wyników na stronie odpowiedzi.
Ta operacja może korzystać z zakresu dostępu OAuth tylko do odczytu.
customerNamePrefix, pageToken i maxResults to opcjonalne ciągi zapytania.
Ten przykład pozwala pobrać wszystkie subskrypcje sprzedawcy, które należą do: klienci, których nazwa zaczyna się od słowa „egzam”:
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"
}
Aktualizowanie abonamentu
Aktualizowanie abonamentów Google Workspace różni się w zależności od abonamentu. Przed aktualizacją planu działania, rozważ następujące kwestie:
Gdy utworzysz subskrypcję, a klient się kwalifikuje, abonament może być 30-dniowym okresem próbnym. Zarówno elastyczne, jak i roczne abonamenty ze zobowiązaniem mogą być bezpłatnymi 30-dniowymi okresami próbnymi. W trakcie okresu próbnego może zmienić abonament na elastyczny lub roczny abonamenty bazujące na zobowiązaniu tak często, jak to konieczne. Ale po zakończeniu okresu próbnego i zaplanowaniu stanie się aktywne, więc aktualizacja planu będzie podlegać tym samym regułom co w przypadku innych subskrypcji aktywne plany. Aby natychmiast przenieść subskrypcję próbną na aktywny abonament, rozpocząć płatną subskrypcję w ramach 30-dniowego bezpłatnego okresu próbnego, Więcej informacji o 30-dniowym okresie próbnym i zasadach kwalifikacji klientów znajdziesz tutaj: Centrum pomocy dla administratorów.
Możesz zmienić abonament elastyczny na abonament z rocznym zobowiązaniem.
Nie możesz zaktualizować abonamentu z rocznym zobowiązaniem.
Nie wszystkie abonamenty są dostępne we wszystkich usługach. Aby dowiedzieć się więcej o tym, usług objętych tymi abonamentami, zobacz Produkty i Kody SKU.
Aby zmienić abonament na 30-dniowy okres próbny lub subskrypcję abonamentu elastycznego na roczny
abonamentu bazującego na zobowiązaniu, użyj tego żądania HTTP POST:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan
Zastąp następujące elementy:
CUSTOMER_ID: domena podstawowa klienta. nazwę użytkownika lub unikalny identyfikator klienta.SUBSCRIPTION_ID: identyfikator subskrypcji, którym jest i niepowtarzalna. Tę wartość możesz pobrać za pomocą Pobieranie wszystkich metod subskrypcji sprzedawcy
Ten przykład aktualizuje subskrypcję przy użyciu parametru subscriptionId z parametrem
wartość 123. customerId to C0123456.
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan
Treść żądania zawiera:
{
"kind": "reseller#changePlanRequest",
"planName": "ANNUAL_MONTHLY_PAY",
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10
},
"purchaseOrderId": "123_March2012"
}
Pomyślna odpowiedź zwraca kod stanu HTTP 201 i zwraca zaktualizowany kod
Ustawienia abonamentu:
{
"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"
}
Aktualizowanie stanowisk w subskrypcji
Aktualizowanie abonamentu z rocznym zobowiązaniem wymaga innej subskrypcji niż aktualizacja subskrypcji abonamentu elastycznego Google Workspace.
Aktualizowanie stanowisk w ramach abonamentu rocznego
Aby zaktualizować ustawienia licencji użytkownika abonamentu rocznego, użyj tych opcji:
Żądanie HTTP POST:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats
Zastąp następujące elementy:
CUSTOMER_ID: domena podstawowa klienta. nazwę użytkownika lub unikalny identyfikator klienta.SUBSCRIPTION_ID: identyfikator subskrypcji, którym jest i niepowtarzalna. Tę wartość możesz pobrać za pomocą Pobieranie wszystkich metod subskrypcji sprzedawcy
Ten przykład aktualizuje subskrypcję przy użyciu subscriptionId 123.
customerId to numer C0123456. Treść żądania różni się w zależności od
typ planu:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats
Subskrypcja Google Workspace w ramach abonamentu z rocznym zobowiązaniem wykorzystuje ten treść żądania do:
zaktualizowanie liczby licencji użytkowników. Wartość numberOfSeats jest
Łącznie. Jeśli na przykład wcześniej było 10 licencji użytkowników, a
zamówienie klienta na 5 nowych licencji, czyli łączną kwotę w treści żądania dotyczącą
numberOfSeats to 15, jak w tym przykładzie:
{
"kind": "subscriptions#seats",
"numberOfSeats": 15
}
Aktualizowanie stanowisk w subskrypcji abonamentu elastycznego
Subskrypcja abonamentu elastycznego Google Workspace wykorzystuje treść żądania do aktualizacji
licencji użytkowników. Wartość maximumNumberOfSeats to suma
między istniejącymi a nowymi licencjami. To jest maksymalna liczba użytkowników
licencji, które można udostępnić na koncie.
{
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15
}
Odpowiedź pomyślna zwraca kod stanu HTTP 201 i zaktualizowany
ustawienia licencji subskrypcji:
{
"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"
}
Aktualizowanie ustawień odnawiania subskrypcji
Aby zaktualizować ustawienia odnawiania subskrypcji z rocznym zobowiązaniem, skorzystaj z
następujące żądanie HTTP POST:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings
Zastąp następujące elementy:
CUSTOMER_ID: domena podstawowa klienta. nazwę użytkownika lub unikalny identyfikator klienta.SUBSCRIPTION_ID: identyfikator subskrypcji, którym jest i niepowtarzalna. Tę wartość możesz pobrać za pomocą Pobieranie wszystkich metod subskrypcji sprzedawcy
Oto przykładowa treść żądania:
{
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}
Właściwość renewalType może mieć dowolną z tych wartości:
AUTO_RENEW_YEARLY_PAY: pod koniec okresu obowiązywania abonamentu z rocznym zobowiązaniem automatycznie odnowi abonament jakoANNUAL_YEARLY_PAYz ten samnumberOfSeats.AUTO_RENEW_MONTHLY_PAY: pod koniec okresu obowiązywania abonamentu z rocznym zobowiązaniem interwału, automatycznie odnów abonament subskrypcji jakoANNUAL_MONTHLY_PAYz tym samym ustawieniemnumberOfSeats.RENEW_CURRENT_USERS_YEARLY_PAY: pod koniec okresu obowiązywania abonamentu z rocznym zobowiązaniem interwał, odnów abonament jakoANNUAL_YEARLY_PAY, ale użyj łączna liczba bieżących aktywnych licencji użytkowników. Jest to ustawienie domyślne. dla aktywnych abonamentów z rocznym zobowiązaniem (płatnych rocznie).RENEW_CURRENT_USERS_MONTHLY_PAY: pod koniec okresu obowiązywania abonamentu z rocznym zobowiązaniem interwał, odnów abonament jakoANNUAL_MONTHLY_PAY, ale użyj łączna liczba bieżących aktywnych licencji użytkowników. Jest to ustawienie domyślne. dla aktywnych abonamentów z rocznym zobowiązaniem (płatnych co miesiąc).RENEW_ON_PROPOSED_OFFER: na koniec bieżącego abonamentu bazującego na zobowiązaniu interwał, odnów zgodnie z najnowszą propozycją odnowienia z wartością numberOfSeats jako liczbą aktualnej liczby aktywnych licencji użytkowników lub proponowanego zobowiązania w zakresie oferty (w zależności od tego, która z tych wartości jest wyższe.SWITCH_TO_PAY_AS_YOU_GO: pod koniec okresu obowiązywania abonamentu z rocznym zobowiązaniem zmień abonament z rocznym zobowiązaniem na abonament elastyczny.CANCEL: z końcem okresu obowiązywania abonamentu z rocznym zobowiązaniem subskrypcja Konto jest zawieszone. Aby dowiedzieć się, jak cofnąć zawieszenie konta, zapoznaj się z Centrum pomocy dla administratorów.
Odpowiedź pomyślna zwraca kod stanu HTTP 201 i zaktualizowany
ustawienia odnawiania subskrypcji:
{
"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"
}
Rozpoczynanie płatnej usługi w ramach bezpłatnej subskrypcji próbnej
Natychmiastowe przeniesienie 30-dniowej bezpłatnej subskrypcji próbnej na usługę płatną
subskrypcja, jeśli abonament został już skonfigurowany na potrzeby okresu próbnego.
subskrypcji, należy użyć tego żądania HTTP POST.
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService
Zastąp następujące elementy:
CUSTOMER_ID: domena podstawowa klienta. nazwę użytkownika lub unikalny identyfikator klienta.SUBSCRIPTION_ID: identyfikator subskrypcji, którym jest i niepowtarzalna. Tę wartość możesz pobrać za pomocą Pobieranie wszystkich metod subskrypcji sprzedawcy
W poniższym przykładzie dyrektywa C0123456 jest ustawiona jako customerId, a parametry
Wartość parametru subscriptionId z 123:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService
Ta operacja nie ma parametrów w treści żądania.
Pomyślna odpowiedź zwraca kod stanu HTTP 201 i zaktualizowane ustawienia subskrypcji:
{
"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"
}
Przechodzenie na wyższą lub niższą wersję subskrypcji
Nie możesz przejść na niższą wersję subskrypcji rocznej w trakcie okresu umowy. Nie możesz też
zaplanować przejście na niższą wersję przy użyciu ustawień odnawiania. Zalecamy ustawienie
ustawień odnawiania, aby przejść na wersję FLEXIBLE, a po upływie terminu odnowienia przejść na niższą wersję.
Aby przejść na wyższą lub niższą wersję subskrypcji, utwórz nową subskrypcję
przy użyciu platformy skuId, na którą chcesz przejść.
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
Zastąp następujące elementy:
CUSTOMER_ID: domena podstawowa klienta. nazwę użytkownika lub unikalny identyfikator klienta.
Ta rozmowa zakończy poprzednią subskrypcję i tworzy nową.
Dowiedz się więcej o: przejście na wyższą lub niższą wersję usługi w sekcji Produkty i na stronie kodów SKU.