REST Resource: subscriptions

{
  "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
  }
}

string

Ta właściwość będzie zawsze zwracana w odpowiedzi w postaci unikalnego identyfikatora wygenerowanego przez Google. Ta prośba może być domeną podstawową lub unikalnym identyfikatorem wygenerowanym przez Google.

string

subscriptionId to identyfikator subskrypcji, który jest unikalny dla każdego klienta. Jest to właściwość wymagana. subscriptionId zmienia się, gdy subskrypcja jest aktualizowana, dlatego nie należy używać tego identyfikatora jako klucza w danych trwałych. Skorzystaj z instrukcji subscriptionId, jak opisano w artykule Pobieranie wszystkich subskrypcji sprzedawcy.

string

Wymagana właściwość. skuId to unikalny identyfikator systemowy produktu przypisany do klienta w ramach subskrypcji. Listę produktów i kodów SKU dostępnych w tej wersji interfejsu API znajdziesz w artykule Identyfikatory produktów i kodów SKU.

string (int64 format)

Właściwość creationTime to data utworzenia subskrypcji. Jest podany w milisekundach w formacie Epoki. Zobacz przykład konwertera epoki.

string

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

object (Seats)

Jest to właściwość wymagana. Liczba i limit licencji użytkowników na pakiet.

object (RenewalSettings)

Ustawienia odnowienia abonamentu rocznego. Szczegółowe informacje znajdziesz w centrum pomocy dla administratorów.

string

Jest to właściwość opcjonalna. Informacje o zamówieniu są przeznaczone dla sprzedawców do wykorzystania w ramach śledzenia firmy. Jeśli zostanie podana wartość purchaseOrderId, pojawi się ona w odpowiedziach interfejsu API i pojawi się na fakturze. Obiekt może zawierać maksymalnie 80 znaków tekstowych.

string

Jest to właściwość opcjonalna.

string

Adres URL strony Subskrypcje klienta w konsoli administracyjnej. Adres URL tylko do odczytu jest generowany przez usługę API. To uprawnienie jest wymagane, jeśli aplikacja kliencka wymaga od klienta wykonania zadania na stronie Subskrypcje w konsoli administracyjnej.

string

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

string

Pole tylko do odczytu zawierające wszystkie możliwe przyczyny zawieszenia subskrypcji. Może się zdarzyć, że w ramach subskrypcji istnieje wiele równolegle nakładających się przyczyn. Subskrypcja STATUS obejmuje SUSPENDED, dopóki wszystkie oczekujące zawieszenia nie zostaną usunięte.

Możliwe opcje:

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

string

Nazwa domeny podstawowej klienta

string

Kod Google (maks. 100 znaków) na rabat na abonamenty. Aby otrzymać zniżkę, kod oferty musi być zawarty w insert żądaniach. Ta właściwość jest opcjonalna, a jeśli jest pusta, obowiązuje standardowy cennik.

string

Wyświetlana zewnętrzna nazwa tylko produktu do odczytu przypisanego do klienta w ramach subskrypcji. Nazwy SKU mogą ulec zmianie według uznania Google. Listę produktów i kodów SKU dostępnych w tej wersji interfejsu API znajdziesz w artykule Identyfikatory produktów i kodów SKU.

object

Właściwość plan jest wymagana. W tej wersji interfejsu API G Suite są dostępne w ramach abonamentu elastycznego, abonamentu rocznego i 30-dniowego bezpłatnego okresu próbnego. Więcej informacji o abonamentach API znajdziesz w zagadnieniach dotyczących interfejsu API.

string

Właściwość planName jest wymagana. To jest nazwa planu. Więcej informacji o abonamentach Google znajdziesz w pojęciach dotyczących interfejsu API.

Możliwe wartości:

• ANNUAL_MONTHLY_PAY – abonament roczny z płatnościami miesięcznymi.
• ANNUAL_YEARLY_PAY – abonament roczny z płatnościami rocznymi.
• FLEXIBLE – abonament elastyczny
• TRIAL – 30-dniowy bezpłatny okres próbny. Po upływie 30 dnia bezpłatnego okresu subskrypcji, jeśli nie zostanie przypisany żaden abonament, zostanie zawieszona subskrypcja próbna. Połączenie z numerem changePlan spowoduje przypisanie abonamentu do okresu próbnego, ale nie spowoduje aktywacji abonamentu. Okres próbny automatycznie rozpocznie się po upływie 30 dnia bezpłatnego okresu próbnego lub natychmiast po wywołaniu usługi startPaidService.
• FREE – bezpłatny abonament jest używany tylko w Cloud Identity i nie powoduje naliczania opłat.

boolean

Wartość logiczna w usłudze isCommitmentPlan określa plan jako abonament roczny:

• true – jest to abonament roczny.
• false – abonament nie jest roczny.

object

W tej wersji interfejsu API roczny okres zobowiązania wynosi 1 rok.

string (int64 format)

Roczny plan zobowiązania (w milisekundach) startTime w milisekundach w formacie UNIX Epoch. Zobacz przykład konwertera epoki.

string (int64 format)

Roczny plan zobowiązania (w milisekundach) w endTime w formacie UNIX Epoch. Zobacz przykład konwertera epoki.

object

Roczny abonament G Suite i elastyczne abonamenty mogą być dostępne w 30-dniowej wersji próbnej. Więcej informacji znajdziesz w artykule Pojęcia związane z interfejsami API.

boolean

Określa, czy subskrypcja obejmuje 30-dniowy bezpłatny okres próbny, czy nie:

• true – subskrypcja jest w okresie próbnym.
• false – abonament nie jest w okresie próbnym.

string (int64 format)

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

object

Informacje o przeniesieniu tylko do odczytu do subskrypcji. Więcej informacji znajdziesz w artykule o pobieraniu subskrypcji możliwych do przeniesienia dla klienta.

string (int64 format)

Czas, w którym token przeniesienia lub intencja przeniesienia wygasa. Czas jest podany w milisekundach w formacie UNIX Epoch.

integer

Wstawienie subskrypcji to minimalna liczba miejsc widoczna w zleceniu przeniesienia tej usługi. Jeśli na przykład klient ma 20 użytkowników, sprzedawca nie może złożyć zamówienia przeniesienia na 15 miejsc. Minimalna liczba miejsc to 20.

string

skuId bieżącej sprzedanej subskrypcji. Są one wypełniane tylko wtedy, gdy klient ma subskrypcję ze starszym kodem SKU, a zasób subskrypcji zawiera skuId zalecanego kodu SKU do przeniesienia.

{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}

integer

Ta usługa jest wymagana i wyłączna w przypadku subskrypcji z abonamentami ANNUAL_MONTHLY_PAY i ANNUAL_YEARLY_PAY. Ta usługa określa maksymalną liczbę licencji przypisanych do użytkowników w ramach subskrypcji. Sprzedawca może dodać więcej licencji, ale po ustawieniu zasady numberOfSeats nie można zmniejszyć jej do momentu odnowienia. Sprzedawca jest fakturowany na podstawie wartości numberOfSeats niezależnie od tego, ile z tych licencji użytkowników jest przypisanych.

integer

Ta usługa jest wymagana i wyłączna w przypadku subskrypcji z abonamentem FLEXIBLE lub TRIAL. Ta usługa określa maksymalną dozwoloną liczbę użytkowników. Tę liczbę można zwiększyć do limitu określonego w umowie sprzedawcy. Minimalna liczba to aktualna liczba użytkowników na koncie klienta.

integer

Pole tylko do odczytu zawierające bieżącą liczbę użytkowników, którzy mają przypisaną licencję na usługę zdefiniowaną w skuId. Wartość w tym polu jest odpowiednikiem liczbowej liczby użytkowników zwróconych przez metodę interfejsu Enterprise License Manager API: listForProductAndSku.

string

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

{
  "renewalType": string,
  "kind": string
}

string

Ustawienia odnowienia abonamentu rocznego. Szczegółowe informacje znajdziesz w centrum pomocy dla administratorów. Podczas odnawiania subskrypcji wymagana jest właściwość renewalType.

string

Wskazuje zasób jako ustawienie odnowienia subskrypcji. Wartość: subscriptions#renewalSettings