REST Resource: subscriptions

Zasób: Subskrypcja

Szablon JSON dotyczący 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 niepowtarzalny identyfikator wygenerowany przez Google. W żądaniu ta usługa może być domeną główną lub unikatowym identyfikatorem wygenerowanym przez Google.
subscriptionId

string

subscriptionId to identyfikator subskrypcji, który jest unikalny dla każdego klienta. To jest wymagana usługa. Ponieważ identyfikator subscriptionId zmienia się po zaktualizowaniu subskrypcji, zalecamy, aby nie używać tego identyfikatora jako klucza do danych trwałych. Użyj subscriptionId zgodnie z opisem w sekcji Pobieranie wszystkich subskrypcji sprzedawcy.
skuId

string

Wymagana właściwość. skuId to unikalny identyfikator systemu SKU produktu przypisany do klienta w ramach subskrypcji. Informacje o produktach i kodach SKU dostępnych w tej wersji interfejsu API znajdziesz w artykule Identyfikatory usług i SKU.
creationTime

string (int64 format)

Właściwość creationTime to data utworzenia subskrypcji. Jest on podawany w milisekundach w formacie Epoch. Zobacz przykładowy konwerter epoki.
kind

string

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

object (Seats)

To jest wymagana usługa. Liczba i limit licencji użytkowników w abonamencie.
renewalSettings

object (RenewalSettings)

Ustawienia odnawiania abonamentu rocznego. Więcej informacji o opcjach odnowienia znajdziesz w Centrum pomocy dla administratorów.
purchaseOrderId

string

To jest właściwość opcjonalna. Informacje o zamówieniu (numer zamówienia) są przeznaczone dla sprzedawców i służą do śledzenia wykorzystania przez ich firmę. Jeśli podana jest wartość purchaseOrderId, pojawia się ona w odpowiedziach interfejsu API i na fakturze. Właściwość ta może zawierać maksymalnie 80 znaków zwykłego tekstu.
status

string

To jest właściwość opcjonalna.
resourceUiUrl

string

Adres URL strony Subskrypcje w konsoli administracyjnej klienta. Adres URL tylko do odczytu jest generowany przez usługę interfejsu API. Jest on używany, jeśli aplikacja klienta wymaga, aby klient wykonał zadanie na stronie Subskrypcje w konsoli administracyjnej.
billingMethod

string

Pole tylko do odczytu, które zwraca bieżącą metodę płatności dla subskrypcji.
suspensionReasons[]

string

Pole tylko do odczytu zawierające enumerację wszystkich bieżących przyczyn zawieszenia subskrypcji. Subskrypcja może mieć wiele równoczesnych, nakładających się powodów zawieszenia. STATUS subskrypcji jest 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 G Suite Resold.
  • RENEWAL_WITH_TYPE_CANCEL – okres zobowiązania klienta dobiegł końca i usługa została anulowana po zakończeniu tego okresu.
  • RESELLER_INITIATED – ręczne zawieszenie zainicjowane przez sprzedawcę.
  • TRIAL_ENDED – bezpłatny okres próbny klienta wygasł, a klient nie wybrał abonamentu.
  • OTHER – klient został zawieszony z wewnętrznych powodów Google (np. z powodu nadużycia lub innego powodu).

customerDomain

string

Nazwa domeny podstawowej klienta
dealCode

string

Kod wydany przez Google (maksymalnie 100 znaków) umożliwiający korzystanie z tańszych cen abonamentów. Aby otrzymać rabat, należy uwzględnić kod oferty w żądaniach insert. Ta właściwość jest opcjonalna. Jeśli pozostanie pusta, zostaną zastosowane standardowe ceny.
skuName

string

Wyświetlana zewnętrzna nazwa SKU produktu przypisana do klienta w ramach subskrypcji. Dostępna tylko do odczytu. Nazwy kodów SKU mogą ulec zmianie według uznania Google. Informacje o produktach i kodach SKU dostępnych w tej wersji interfejsu API znajdziesz w artykule Identyfikatory usług i SKU.
plan

object

Właściwość plan jest wymagana. W tej wersji interfejsu API abonamenty G Suite to abonament elastyczny, abonament z rocznym zobowiązaniem oraz 30-dniowy bezpłatny okres próbny. Więcej informacji o planach płatności interfejsu API znajdziesz w artykule Koncepcje interfejsu API.
plan.planName

string

Właściwość planName jest wymagana. To jest nazwa abonamentu. Więcej informacji o planach płatności Google znajdziesz w artykule Koncepcje interfejsu API.

Możliwe wartości:

  • ANNUAL_MONTHLY_PAY – abonament roczny z płatnościami miesięcznymi.
  • ANNUAL_YEARLY_PAY – roczny abonament z płatnościami rocznymi.
  • FLEXIBLE – abonament elastyczny,
  • TRIAL – 30-dniowy bezpłatny okres próbny. Subskrypcja w okresie próbnym zostanie zawieszona po 30 dniu bezpłatnego okresu próbnego, jeśli nie zostanie przypisany żaden abonament. Wywołanie metody changePlan spowoduje przypisanie abonamentu do okresu próbnego, ale nie spowoduje jego aktywacji. Po 30 dniach bezpłatnego okresu próbnego lub natychmiast po zadzwonieniu do startPaidService automatycznie rozpocznie się płatny okres próbny.
  • FREE – bezpłatny abonament jest dostępny tylko w przypadku kodu SKU Cloud Identity i nie wiąże się z żadnymi opłatami.

plan.isCommitmentPlan

boolean

Wartość logiczna właściwości isCommitmentPlan wskazuje, że abonament jest rocznym zobowiązaniem:

  • true – abonament jest abonamentem rocznym.
  • false – abonament nie jest rocznym planem zobowiązania.
plan.commitmentInterval

object

W tej wersji interfejsu API interwał abonamentu rocznego wynosi 1 rok.

plan.commitmentInterval.startTime

string (int64 format)

Interval startTime w planie rocznego zobowiązania w milisekundach w formacie uniksowym. Zobacz przykładowy konwerter epoki.
plan.commitmentInterval.endTime

string (int64 format)

Interval endTime w planie rocznego zobowiązania w milisekundach w formacie UNIX Epoch. Zobacz przykładowy konwerter epoki.
trialSettings

object

Abonamenty G Suite z rocznym zobowiązaniem i elastycznymi planami płatności mogą być objęte 30-dniowym bezpłatnym okresem próbnym. Więcej informacji znajdziesz w artykule o koncepcjach interfejsu API.
trialSettings.isInTrial

boolean

Określa, czy subskrypcja jest w ramach 30-dniowego bezpłatnego okresu próbnego:

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

string (int64 format)

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

object

Informacje dotyczące subskrypcji związane z przeniesieniem tylko do odczytu. Więcej informacji znajdziesz w artykule Pobieranie abonamentów do przeniesienia dla klienta.
transferInfo.transferabilityExpirationTime

string (int64 format)

Czas, w którym token przeniesienia lub zamiar przeniesienia wygaśnie. Czas jest podany w milisekundach w formacie epoki uniksowej.
transferInfo.minimumTransferableSeats

integer

Podczas wstawiania subskrypcji jest to minimalna liczba miejsc wymieniona w zamówieniu na przeniesienie tego produktu. Jeśli na przykład klient ma 20 użytkowników, sprzedawca nie może złożyć zamówienia na przeniesienie 15 miejsc. Minimalna liczba miejsc to 20.
transferInfo.currentLegacySkuId

string

skuId bieżącej odsprzedawanej subskrypcji. Ta wartość jest wypełniana tylko wtedy, gdy klient ma subskrypcję ze starszym kodem SKU, a zasób subskrypcji zawiera skuId zalecanego do przeniesienia kodu SKU.

Stanowiska

Szablon JSON dla miejsc w ramach subskrypcji.

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

integer

To wymagana właściwość, która jest dostępna tylko w przypadku abonamentów z abonamentami ANNUAL_MONTHLY_PAY i ANNUAL_YEARLY_PAY. Ta właściwość określa maksymalną liczbę licencji, które można przypisać użytkownikom w subskrypcji. Sprzedawca może dodać więcej licencji, ale po ich ustawieniu liczba numberOfSeats nie może zostać zmniejszona do czasu odnowienia. Reseller otrzymuje fakturę na podstawie wartości numberOfSeats niezależnie od liczby przypisanych licencji użytkowników.

maximumNumberOfSeats

integer

To jest wymagana właściwość, która jest dostępna tylko w przypadku abonamentów z planami FLEXIBLE lub TRIAL. Ta właściwość określa maksymalną liczbę użytkowników z licencją dozwolonych w abonamencie. Liczba ta może zostać zwiększona do maksymalnego limitu określonego w umowie z resellerem. Minimalna liczba to obecna 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 produkt zdefiniowany w skuId. Wartość tego pola jest równa liczbie użytkowników zwróconej przez metodę interfejsu Enterprise License Manager API: listForProductAndSku.
kind

string

Określa zasób jako ustawienie miejsca na subskrypcję. Wartość: subscriptions#seats

RenewalSettings

Szablon JSON ustawień odnawiania subskrypcji.

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

string

Ustawienia odnawiania abonamentu rocznego. Więcej informacji o opcjach odnowienia znajdziesz w Centrum pomocy dla administratorów. W przypadku odnawiania subskrypcji wymagana jest właściwość renewalType.
kind

string

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

Metody

activate

 Aktywuje subskrypcję, która została wcześniej zawieszona przez sprzedawcę.

changePlan

 Aktualizuje abonament.

changeRenewalSettings

 Zmienia ustawienia odnawiania licencji użytkownika.

changeSeats

 Zmienia ustawienia licencji użytkownika subskrypcji.

delete

 anulować, zawiesić lub przenieść subskrypcję do bezpośredniego.

get

 Pobiera określoną subskrypcję.

insert

 tworzy lub przenosi subskrypcję.

list

 listy subskrypcji zarządzanych przez sprzedawcę.

startPaidService

 natychmiast przekształcić 30-dniowy bezpłatny okres próbny w płatną subskrypcję usługi;

suspend

 Zawiesza aktywną subskrypcję.