REST Resource: subscriptions

Zasób: subscription (subskrypcja)

Szablon JSON subskrypcji.

Zapis JSON 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
Pola
customerId

string

Ta właściwość będzie zawsze zwracana w odpowiedzi jako unikalny identyfikator wygenerowany przez Google. W żądaniu tą usługą może być domena podstawowa lub unikalny identyfikator wygenerowany przez Google.
subscriptionId

string

subscriptionId to identyfikator subskrypcji, który jest unikalny dla każdego klienta. Jest to właściwość wymagana. Identyfikator subscriptionId zmienia się wraz z aktualizowaniem subskrypcji, więc nie zalecamy używania tego identyfikatora jako klucza dla danych trwałych. Użyj narzędzia subscriptionId w sposób opisany w sekcji Pobieranie wszystkich subskrypcji sprzedawcy.
skuId

string

Właściwość wymagana. skuId to unikalny identyfikator systemu dla kodu SKU produktu przypisany do klienta objętego subskrypcją. Informacje o usługach i kodach SKU dostępnych w tej wersji interfejsu API znajdziesz w artykule Identyfikatory produktów i SKU.
creationTime

string (int64 format)

Właściwość creationTime to data utworzenia subskrypcji. Jest podawana w milisekundach w formacie epoki. Zobacz przykładowy Konwerter epoki.
kind

string

Wskazuje zasób jako subskrypcję. Wartość: reseller#subscription
seats

object (Seats)

Jest to właściwość wymagana. Liczba i limit licencji użytkowników w ramach abonamentu.
renewalSettings

object (RenewalSettings)

Ustawienia odnawiania abonamentu z rocznym zobowiązaniem. Szczegółowe informacje znajdziesz w sekcji o opcjach odnowienia w Centrum pomocy dla administratorów.
purchaseOrderId

string

Jest to właściwość opcjonalna. Sprzedawcy mogą używać tych informacji o zamówieniach do śledzenia ich użytkowania w firmie. Jeśli podana jest wartość purchaseOrderId, pojawia się ona w odpowiedziach interfejsu API i pojawia się na fakturze. Właściwość może zawierać maksymalnie 80 znaków zwykłego tekstu.
status

string

Jest to właściwość opcjonalna.
resourceUiUrl

string

Adres URL strony Subskrypcje klienta w konsoli administracyjnej. Adres URL tylko do odczytu jest generowany przez usługę API. Jest on używany, jeśli aplikacja kliencka wymaga od klienta wykonania zadania na stronie Subskrypcje w konsoli administracyjnej.
billingMethod

string

Pole tylko do odczytu, które zwraca bieżącą formę płatności za subskrypcję.
suspensionReasons[]

string

Pole tylko do odczytu zawierające wszystkie bieżące przyczyny zawieszenia subskrypcji. Subskrypcja może mieć wiele równoczesnych, nakładających się przyczyn zawieszenia. STATUS subskrypcji wynosi SUSPENDED, dopóki nie usuniesz wszystkich oczekujących zawieszeń.

Możliwe opcje:

  • PENDING_TOS_ACCEPTANCE – klient nie zalogował się i nie zaakceptował Warunków korzystania z usługi sprzedaży G Suite.
  • RENEWAL_WITH_TYPE_CANCEL – zobowiązanie klienta zakończyło się, a jego usługa została anulowana z końcem umowy.
  • RESELLER_INITIATED – konto zostało ręcznie zawieszone przez sprzedawcę.
  • TRIAL_ENDED – okres próbny klienta zakończył się bez wybranego abonamentu.
  • OTHER – konto klienta zostało zawieszone z powodów wewnętrznych Google (np. z powodu nadużycia lub innego).

customerDomain

string

Nazwa domeny podstawowej klienta
dealCode

string

Kod wydany przez Google (maks. 100 znaków) umożliwiający korzystanie z rabatu na abonamenty. Aby otrzymać zniżkę, musisz uwzględnić kod umowy w prośbach (insert). Ta właściwość jest opcjonalna. Jeśli jej nie wypełnisz, obowiązują standardowe ceny.
skuName

string

Wyświetlana tylko do odczytu zewnętrzna wyświetlana nazwa kodu SKU produktu przypisanego klientowi objętemu subskrypcją. Google może zmieniać nazwy SKU według własnego uznania. Informacje o usługach i kodach SKU dostępnych w tej wersji interfejsu API znajdziesz w artykule Identyfikatory produktów i SKU.
plan

object

Właściwość plan jest wymagana. W tej wersji interfejsu API abonamenty G Suite obejmują abonament elastyczny, abonament z rocznym zobowiązaniem i 30-dniowy bezpłatny okres próbny. Więcej informacji o abonamentach za korzystanie z interfejsu API znajdziesz w artykule Pojęcia związane z interfejsem API.
plan.planName

string

Właściwość planName jest wymagana. Jest to nazwa abonamentu. Więcej informacji o abonamentach Google znajdziesz w artykule Pojęcia związane z interfejsami API.

Możliwe wartości:

  • ANNUAL_MONTHLY_PAY – abonament z rocznym zobowiązaniem z płatnościami miesięcznymi.
  • ANNUAL_YEARLY_PAY – abonament z rocznym zobowiązaniem z płatnościami rocznymi.
  • FLEXIBLE – abonament elastyczny
  • TRIAL – 30-dniowy bezpłatny okres próbny. Jeśli nie przypiszesz abonamentu, subskrypcja w okresie próbnym zostanie zawieszona po 30 dniu bezpłatnego okresu próbnego. Połączenie z numerem changePlan spowoduje przypisanie abonamentu do okresu próbnego, ale nie spowoduje jego aktywacji. W przypadku okresu próbnego przypisany do niego abonament rozpocznie się automatycznie po 30 dniu bezpłatnym lub natychmiast po wywołaniu numeru startPaidService.
  • FREE – abonament bezpłatny jest dostępny tylko w Cloud Identity i nie wiąże się z żadnymi opłatami.

plan.isCommitmentPlan

boolean

Wartość logiczna właściwości isCommitmentPlan określa plan jako abonament z rocznym zobowiązaniem:

  • true – abonament jest rocznym zobowiązaniem.
  • false – abonament nie jest rocznym zobowiązaniem.
plan.commitmentInterval

object

W tej wersji interfejsu API interwał z rocznym zobowiązaniem to 1 rok.

plan.commitmentInterval.startTime

string (int64 format)

Okres startTime w milisekundach w ramach planu z rocznym zobowiązaniem w formacie UNIX Epoch. Zobacz przykładowy Konwerter epoki.
plan.commitmentInterval.endTime

string (int64 format)

Okres endTime w milisekundach w ramach planu z rocznym zobowiązaniem w formacie UNIX Epoch. Zobacz przykładowy Konwerter epoki.
trialSettings

object

Roczne zobowiązanie i abonamenty elastyczne G Suite są dostępne w ramach 30-dniowego bezpłatnego okresu próbnego. Więcej informacji znajdziesz w artykule o pojęciach związanych z interfejsami API (w języku angielskim).
trialSettings.isInTrial

boolean

Określa, czy abonament jest objęty 30-dniowym bezpłatnym okresem próbnym:

  • true – abonament jest w trakcie okresu próbnego.
  • false – abonament nie jest w wersji próbnej.
trialSettings.trialEndTime

string (int64 format)

Data zakończenia okresu próbnego. Wartość jest podawana w milisekundach w formacie UNIX Epoch. Zobacz przykładowy Konwerter epoki.
transferInfo

object

Informacje o przenoszeniu subskrypcji tylko do odczytu. Więcej informacji znajdziesz w artykule o pobieraniu subskrypcji z możliwością przeniesienia dla klienta.
transferInfo.transferabilityExpirationTime

string (int64 format)

Data wygaśnięcia tokena przeniesienia lub zamiaru przeniesienia. Godzina jest podana w milisekundach w formacie UNIX Epoch.
transferInfo.minimumTransferableSeats

integer

Podczas wstawiania subskrypcji jest to minimalna liczba stanowisk podanych w zamówieniu przeniesienia dotyczącym tej usługi. Jeśli na przykład klient ma 20 użytkowników, sprzedawca nie może złożyć zamówienia na przeniesienie obejmujące 15 stanowisk. Minimalna liczba to 20 stanowisk.
transferInfo.currentLegacySkuId

string

skuId bieżącej subskrypcji sprzedawanej. To pole jest wypełniane tylko wtedy, gdy klient ma subskrypcję ze starszą wersją SKU, a zasób subskrypcji zawiera kod SKU skuId zalecany do przeniesienia.

Stanowiska

Szablon JSON dla stanowisk w ramach subskrypcji.

Zapis JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Pola
numberOfSeats

integer

Ta usługa jest wymagana i dotyczy wyłącznie subskrypcji z abonamentami ANNUAL_MONTHLY_PAY i ANNUAL_YEARLY_PAY. Ta usługa określa maksymalną liczbę licencji, które można przypisać użytkownikom w ramach subskrypcji. Sprzedawca może dodać więcej licencji, ale gdy skonfigurujesz tę opcję, numberOfSeats nie będzie można zmniejszyć do momentu odnowienia. Sprzedawca jest fakturowany na podstawie wartości numberOfSeats niezależnie od liczby przypisanych licencji użytkowników.

maximumNumberOfSeats

integer

Ta usługa jest wymagana i dotyczy wyłącznie subskrypcji z abonamentem FLEXIBLE lub TRIAL. Ta właściwość określa maksymalną liczbę licencjonowanych użytkowników dozwolonych w ramach subskrypcji. Możesz zwiększyć tę liczbę do wartości maksymalnej określonej w umowie sprzedawcy. Minimalna liczba to bieżąca liczba użytkowników na koncie klienta.

licensedNumberOfSeats

integer

Pole tylko do odczytu zawierające bieżącą liczbę użytkowników, którym przypisano licencję na usługę określoną w skuId. Wartość tego pola jest równa liczbowej liczbie użytkowników zwróconych przez metodę Enterprise License Manager API: listForProductAndSku.
kind

string

Identyfikuje zasób jako ustawienie stanowiska subskrypcji. Wartość: subscriptions#seats

RenewalSettings

Szablon JSON z ustawieniami odnawiania subskrypcji.

Zapis JSON 
{
  "renewalType": string,
  "kind": string
}
Pola
renewalType

string

Ustawienia odnawiania abonamentu z rocznym zobowiązaniem. Szczegółowe informacje znajdziesz w sekcji o opcjach odnowienia w Centrum pomocy dla administratorów. Podczas odnawiania subskrypcji wymagana jest właściwość renewalType.
kind

string

Identyfikuje zasób jako ustawienie odnawiania subskrypcji. Wartość: subscriptions#renewalSettings

Metody

activate

 Aktywuje subskrypcję zawieszoną wcześniej przez sprzedawcę.

changePlan

 Aktualizuje abonament.

changeRenewalSettings

 Aktualizuje ustawienia odnawiania licencji użytkownika.

changeSeats

 Aktualizuje ustawienia licencji użytkownika subskrypcji.

delete

 anuluje, zawiesza lub przenosi subskrypcję, aby umożliwić jej przekierowanie.

get

 Pobiera konkretną subskrypcję.

insert

 Powoduje utworzenie lub przeniesienie subskrypcji.

list

 Listy subskrypcji zarządzanych przez sprzedawcę.

startPaidService

 Natychmiast zmień 30-dniowy bezpłatny okres próbny na płatną subskrypcję.

suspend

 Zawiesza aktywną subskrypcję.