Pobieranie i aktualizowanie subskrypcji

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Po pobraniu subskrypcji możesz skorzystać z informacji zawartych w odpowiedzi, która się powiedzie, aby zmienić stan subskrypcji lub ją zaktualizować. Na tej stronie opisujemy różne sposoby pobierania i aktualizowania subskrypcji.

Pobieranie subskrypcji

Aby pobrać zamówioną lub przesłaną subskrypcję, użyj tego żądania HTTP GET.

GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID

Zastąp następujące elementy:

  • CUSTOMER_ID: nazwa domeny podstawowej klienta lub unikalny identyfikator klienta.
  • SUBSCRIPTION_ID: unikalny identyfikator subskrypcji dla każdego klienta. Tę wartość możesz pobrać, korzystając z metody Pobierz wszystkie subskrypcje sprzedawcy.

Ta operacja nie ma parametrów w treści żądania.

Pomyślna odpowiedź zwraca kod stanu HTTP 200 i ustawienia subskrypcji. W przykładowej odpowiedzi właściwość isInTrial jest false, ale nie ma usługi trialEndTime. Oznacza to, że ten klient nigdy nie korzystał z 30-dniowego bezpłatnego okresu próbnego w ramach 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"
}

Pobieranie wszystkich subskrypcji dla klienta

Aby pobrać wszystkie subskrypcje określonego klienta, które zostały zamówione lub przeniesione, użyj tego żą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: nazwa domeny podstawowej klienta lub unikalny identyfikator klienta.
  • START_DATE: data rozpoczęcia w formacie YYYY-MM-DD.
  • MAX_NUMBER: maksymalna liczba wyników zwróconych na stronie odpowiedzi.

Ta operacja nie ma parametrów w treści żądania.

Pomyślna odpowiedź zwraca kod stanu HTTP 200 oraz listę subskrypcji i ustawień klienta. Lista subskrypcji może zawierać produkty, którymi nie zarządza się w tej wersji interfejsu Reseller API.

Jeśli nie zarządzasz klientem, zwracany jest błąd 403 "Forbidden".

Pobieranie wszystkich subskrypcji, które można przenieść

Aby pobrać wszystkie subskrypcje klienta, które mogą zostać przeniesione do zarządzania sprzedawcy, użyj poniższego żądania HTTP GET i dołącz token autoryzacji. Wymagany jest customerId i unikalny identyfikator klienta zwracany podczas pobierania konta klienta sprzedaży. customerAuthToken to token przeniesienia udostępniony przez klienta, który jest charakterystyczny dla Twojego identyfikatora sprzedawcy. Wygenerowana przez klienta jest ważna przez 14 dni. Więcej informacji o generowaniu tokena przez klientów znajdziesz w artykule Przenoszenie konta 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: nazwa domeny podstawowej klienta lub unikalny identyfikator klienta.
  • AUTH_TOKEN: token przeniesienia dostarczony przez klienta odpowiadający Twojemu identyfikatorowi sprzedawcy. Wygenerowany przez klienta jest ważny przez 14 dni. Więcej informacji o generowaniu tokena przez klientów znajdziesz w artykule Przenoszenie konta Google Workspace do sprzedawcy. Jeśli ta wartość jest nieprawidłowa lub utraciła ważność, odpowiedź interfejsu API zwraca błąd 403 "Forbidden".
  • START_DATE: data rozpoczęcia w formacie YYYY-MM-DD.
  • MAX_NUMBER: maksymalna liczba wyników zwróconych na stronie odpowiedzi.

Ta operacja nie ma parametrów w treści żądania.

Po zwróceniu odpowiedzi zwracany jest kod stanu HTTP 200 oraz lista subskrypcji klienta, które można przenieść, z datą ważności tokena przeniesienia i minimalną liczbą stanowisk wymaganych w zamówieniu przeniesienia. Klient może mieć 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 za pomocą operacji zbiorczej, przenieś je wszystkie. Przeniesienie subskrypcji po kolei powoduje błąd. Dodatkowo operacja wsadowa przenosi subskrypcje tylko ze stanem ACTIVE. Więcej informacji znajdziesz w artykule Przenoszenie subskrypcji.

Pobierz wszystkie subskrypcje sprzedawców

Aby pobrać wszystkie zamówione lub przeniesione subskrypcje sprzedawcy, użyj poniższego żą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órej subskrypcji szukasz.
  • TOKEN: token identyfikujący konkretną stronę wyników, która powinna zostać zwrócona przez serwer.
  • MAX_NUMBER: maksymalna liczba wyników zwróconych na stronie odpowiedzi.

Ta operacja może używać zakresu dostępu tylko do odczytu OAuth. customerNamePrefix, pageToken i maxResults to opcjonalne ciągi zapytań.

Ten przykład pobiera wszystkie subskrypcje sprzedawcy należące do klientów, których nazwa rozpoczyna się od „exam”:

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

Abonamenty Google Workspace różnią się w zależności od abonamentu. Zanim zaktualizujesz plan, weź pod uwagę te informacje:

  • Gdy utworzysz subskrypcję, a klient ją spełni, może to być 30-dniowy okres próbny. Abonamenty elastyczne i roczne mogą wymagać 30-dniowego bezpłatnego okresu próbnego. W trakcie okresu próbnego możesz dowolnie zmieniać abonament w ramach abonamentu elastycznego lub rocznego. Jednak po zakończeniu okresu próbnego i aktywowaniu planu zaktualizowanie go jest zgodne z tymi samymi regułami co inne aktywne subskrypcje. Aby natychmiast przenieść subskrypcję próbną do aktywnego abonamentu, rozpocznij płatną usługę z 30-dniowej bezpłatnej wersji próbnej. Więcej informacji o 30-dniowym okresie próbnym i regułach kwalifikacji klienta znajdziesz w Centrum pomocy dla administratorów.

  • Możesz zmienić abonament elastyczny na abonament roczny.

  • Nie możesz aktualizować abonamentu rocznego.

  • Nie wszystkie abonamenty działają ze wszystkimi usługami. Więcej informacji o tym, które usługi są używane w ramach tych abonamentów, znajdziesz w artykule Usługi i kody SKU.

Aby zaktualizować plan 30-dniowego okresu próbnego lub abonamentu elastycznego na abonament roczny, 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: nazwa domeny podstawowej klienta lub unikalny identyfikator klienta.
  • SUBSCRIPTION_ID: unikalny identyfikator subskrypcji dla każdego klienta. Tę wartość możesz pobrać, korzystając z metody Pobierz wszystkie subskrypcje sprzedawcy.

Ten przykład aktualizuje subskrypcję o subscriptionId o wartości 123. customerId to C0123456.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

Treść żądania zawiera te elementy:

{
  "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 zaktualizowane ustawienia planu 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": 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 subskrypcji

Do aktualizowania abonamentu rocznego wymagane są inne usługi niż do abonamentu abonamentu Google Workspace.

Zmienianie liczby osób w abonamencie rocznym

Aby zaktualizować ustawienia licencji użytkownika dotyczące abonamentu rocznego, użyj tego żądania 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: nazwa domeny podstawowej klienta lub unikalny identyfikator klienta.
  • SUBSCRIPTION_ID: unikalny identyfikator subskrypcji dla każdego klienta. Tę wartość możesz pobrać, korzystając z metody Pobierz wszystkie subskrypcje sprzedawcy.

Ten przykład aktualizuje subskrypcję o subscriptionId. customerId to C0123456. Treść żądania różni się w zależności od typu planu:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

Subskrypcja abonamentu rocznego Google Workspace korzysta z treści tego żądania do aktualizowania liczby licencji użytkowników. Wartość numberOfSeats jest liczbą całkowitą. Jeśli na przykład masz 10 licencji użytkowników i masz zamówienie klienta na 5 nowych licencji, łączna liczba w treści żądania numberOfSeats wynosi 15, jak w tym przykładzie:

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

Aktualizowanie miejsc w ramach abonamentu elastycznego

Subskrypcja abonamentu elastycznego Google Workspace używa treści żądania do aktualizowania licencji użytkowników. Wartość maximumNumberOfSeats to suma istniejących licencji i nowych licencji. Jest to maksymalna liczba licencji użytkowników, które można udostępnić na koncie.

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

Pomyślna odpowiedź zwraca kod stanu HTTP 201 i zaktualizowane 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 rocznej, użyj tego żądania 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: nazwa domeny podstawowej klienta lub unikalny identyfikator klienta.
  • SUBSCRIPTION_ID: unikalny identyfikator subskrypcji dla każdego klienta. Tę wartość możesz pobrać, korzystając z metody Pobierz wszystkie subskrypcje 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: na koniec okresu rocznego abonamentu automatycznie odnów abonament w ramach abonamentu ANNUAL_YEARLY_PAY z tą samą wartością numberOfSeats.
  • AUTO_RENEW_MONTHLY_PAY: z końcem umowy rocznego zobowiązania automatycznie odnów abonament w ramach abonamentu ANNUAL_MONTHLY_PAY z tym samym numberOfSeats.
  • RENEW_CURRENT_USERS_YEARLY_PAY: po zakończeniu umowy rocznego abonamentu odnów abonament jako ANNUAL_YEARLY_PAY, ale wykorzystaj łączną liczbę aktywnych licencji użytkowników. Jest to domyślne ustawienie aktywnych abonamentów rocznych (płatnych co rok).
  • RENEW_CURRENT_USERS_MONTHLY_PAY: po zakończeniu umowy rocznego abonamentu odnów abonament jako ANNUAL_MONTHLY_PAY, ale wykorzystaj łączną liczbę aktywnych licencji użytkowników. Jest to domyślne ustawienie aktywnych aktywnych zobowiązań rocznych (płatnych co miesiąc).
  • RENEW_ON_PROPOSED_OFFER: po zakończeniu bieżącego okresu zobowiązania odnów umowę, korzystając z najnowszej oferty pakietowej, podając liczbę aktywnych licencji użytkowników lub liczbę proponowanych licencji (w zależności od tego, która z nich jest większa).
  • SWITCH_TO_PAY_AS_YOU_GO: z końcem umowy rocznego abonamentu zmieniasz abonament roczny na abonament elastyczny.
  • CANCEL: po zakończeniu rocznego okresu abonamentu subskrypcja jest zawieszona. Informacje o tym, jak cofnąć zawieszenie konta, znajdziesz w Centrum pomocy dla administratorów.

Pomyślna odpowiedź zwraca kod stanu HTTP 201 i zaktualizowane 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

Aby natychmiast przenieść 30-dniowy bezpłatny okres próbny na subskrypcję usług płatnych, jeśli abonament jest już skonfigurowany, użyj 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: nazwa domeny podstawowej klienta lub unikalny identyfikator klienta.
  • SUBSCRIPTION_ID: unikalny identyfikator subskrypcji dla każdego klienta. Tę wartość możesz pobrać, korzystając z metody Pobierz wszystkie subskrypcje sprzedawcy.

Ten przykład ma wartość C0123456 jako customerId i subscriptionId jako wartość 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

Abonamentów rocznych nie można zmniejszać w środku okresu ważności ani nie można tego zrobić przy użyciu ustawień odnawiania. Zalecamy zmianę ustawień odnawiania na FLEXIBLE i przejście na niższą wersję po upływie okresu odnowienia.

Aby przejść na wyższą lub niższą wersję, utwórz nową subskrypcję z usługą skuId, na którą chcesz przejść na wyższą lub niższą wersję usługi.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

Zastąp następujące elementy:

  • CUSTOMER_ID: nazwa domeny podstawowej klienta lub unikalny identyfikator klienta.

To połączenie zakończy poprzednią subskrypcję i utworzy nową.

Więcej informacji o uaktualnieniach do niższej wersji znajdziesz na stronie Produkty i kody SKU.