REST Resource: subscriptions

Ресурс: Подписка

Шаблон JSON для подписки.

Представление 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
  }
}
Поля
customerId

string

Это свойство всегда будет возвращаться в ответе как уникальный идентификатор, сгенерированный Google. В запросе этим свойством может быть либо основной домен, либо уникальный идентификатор, сгенерированный Google.

subscriptionId

string

« subscriptionId — это идентификатор подписки, уникальный для каждого клиента. Это обязательное свойство. Поскольку идентификатор subscriptionId изменяется при обновлении подписки, мы не рекомендуем использовать этот идентификатор в качестве ключа для постоянных данных. Используйте subscriptionId , как описано в разделе Получение всех подписок торгового посредника .

skuId

string

Обязательное свойство. skuId — это уникальный системный идентификатор SKU продукта, назначенный покупателю в подписке. Информацию о продуктах и ​​артикулах, доступных в этой версии API, см. в разделе Идентификаторы продуктов и артикулов .

creationTime

string ( int64 format)

Свойство creationTime — это дата создания подписки. Это в миллисекундах с использованием формата Epoch. См. пример конвертера эпох .

kind

string

Идентифицирует ресурс как подписку. Значение: reseller#subscription

seats

object ( Seats )

Это обязательное свойство. Количество и лимит лицензий на рабочие места пользователей в плане.

renewalSettings

object ( RenewalSettings )

Настройки продления годового плана обязательств. Для получения более подробной информации см. варианты продления в справочном центре администратора .

purchaseOrderId

string

Это необязательное свойство. Эта информация о заказе на поставку (PO) предназначена для торговых посредников, чтобы использовать их для отслеживания использования своей компанией. Если указано значение purchaseOrderId , оно появляется в ответах API и отображается в счете. Свойство принимает до 80 символов обычного текста.

status

string

Это необязательное свойство.

resourceUiUrl

string

URL страницы подписок клиента в консоли администратора. URL-адрес только для чтения создается службой API. Это используется, если ваше клиентское приложение требует, чтобы клиент выполнил задачу на странице «Подписки» в консоли администратора.

billingMethod

string

Поле только для чтения, которое возвращает текущий метод выставления счетов для подписки.

suspensionReasons[]

string

Поле только для чтения, содержащее перечисление всех текущих причин приостановки подписки. Подписка может иметь множество одновременных перекрывающихся причин приостановки. STATUS подписки SUSPENDED до тех пор, пока не будут удалены все ожидающие приостановки.

Возможные варианты включают в себя:

  • PENDING_TOS_ACCEPTANCE — клиент не вошел в систему и не принял Условия использования G Suite Resold.
  • RENEWAL_WITH_TYPE_CANCEL — обязательство клиента закончилось, и его услуга была отменена в конце срока их действия.
  • RESELLER_INITIATED — приостановка вручную, инициированная торговым посредником.
  • TRIAL_ENDED – срок действия пробной версии истек, но план не был выбран.
  • OTHER . Клиент заблокирован по внутренней причине Google (например, злоупотребление или иное).

customerDomain

string

Основное доменное имя клиента

dealCode

string

Выданный Google код (максимум 100 символов) для получения скидки на планы подписки. Код сделки должен быть включен в запросы на insert , чтобы получить скидку. Это свойство является необязательным. Если оставить пустым, применяются обычные цены.

skuName

string

Доступное только для чтения внешнее отображаемое имя для артикула продукта, назначенного покупателю в подписке. Названия SKU могут быть изменены по усмотрению Google. Информацию о продуктах и ​​артикулах, доступных в этой версии API, см. в разделе Идентификаторы продуктов и артикулов .

plan

object

Свойство plan является обязательным. В этой версии API планами G Suite являются гибкий план, годовой план с обязательствами и 30-дневный бесплатный пробный план. Дополнительные сведения о тарифных планах API см. в концепциях API .

plan.planName

string

Свойство planName является обязательным. Это название плана подписки. Дополнительную информацию о тарифных планах Google см. в концепциях API .

Возможные значения:

  • ANNUAL_MONTHLY_PAY — Годовой план обязательств с ежемесячными платежами.
  • ANNUAL_YEARLY_PAY — Годовой план обязательств с ежегодными платежами
  • FLEXIBLE — Гибкий план
  • TRIAL — 30-дневный бесплатный пробный план. Пробная подписка будет приостановлена ​​после 30-го бесплатного дня, если не назначен тарифный план. Вызов changePlan назначит план оплаты пробной версии, но не активирует план. Пробная версия автоматически начнет свой назначенный тарифный план после 30-го бесплатного дня или сразу после вызова startPaidService .
  • FREE . Бесплатный план является эксклюзивным для SKU Cloud Identity и не требует оплаты.

plan.isCommitmentPlan

boolean

Логическое значение свойства isCommitmentPlan идентифицирует план как годовой план обязательств:

  • true — план подписки является годовым планом обязательств.
  • false — план не является годовым планом обязательств.

plan.commitmentInterval

object

В этой версии API интервал годового плана обязательств составляет один год.

plan.commitmentInterval.startTime

string ( int64 format)

startTime интервала годового плана обязательств в миллисекундах с использованием формата эпохи UNIX. См. пример конвертера эпох .

plan.commitmentInterval.endTime

string ( int64 format)

endTime интервала годового плана обязательств в миллисекундах с использованием формата эпохи UNIX. См. пример конвертера эпох .

trialSettings

object

Годовое обязательство G Suite и гибкие планы оплаты могут быть включены в 30-дневную бесплатную пробную версию. Для получения дополнительной информации см. концепции API .

trialSettings.isInTrial

boolean

Определяет, находится ли план подписки в 30-дневной бесплатной пробной версии или нет:

  • true — план находится в испытании.
  • false — план не находится в испытании.

trialSettings.trialEndTime

string ( int64 format)

Дата окончания пробного периода. Значение указывается в миллисекундах с использованием формата эпохи UNIX. См. пример конвертера эпох .

transferInfo

object

Доступная только для чтения информация о переносе для подписки. Дополнительные сведения см. в разделе получение передаваемых подписок для клиента .

transferInfo.transferabilityExpirationTime

string ( int64 format)

Время, когда токен передачи или намерение передать истечет. Время указывается в миллисекундах в формате UNIX Epoch.

transferInfo.minimumTransferableSeats

integer

При вставке подписки это минимальное количество мест, указанное в заказе на перенос для этого продукта. Например, если у клиента 20 пользователей, торговый посредник не может разместить заказ на перенос 15 рабочих мест. Минимум 20 мест.

transferInfo.currentLegacySkuId

string

skuId текущей перепроданной подписки. Это значение заполняется только в том случае, если у клиента есть подписка с устаревшим номером SKU, а ресурс подписки заполнен skuId SKU, рекомендованного для переноса.

Сиденья

Шаблон JSON для мест по подписке.

Представление JSON
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Поля
numberOfSeats

integer

Это обязательное свойство, эксклюзивное для подписок с ANNUAL_MONTHLY_PAY и ANNUAL_YEARLY_PAY . Это свойство задает максимальное количество лицензий, назначаемых пользователям в рамках подписки. Торговый посредник может добавить больше лицензий, но после установки число numberOfSeats не может быть уменьшено до продления. Торговому посреднику выставляется счет на основе значения numberOfSeats независимо от того, сколько таких пользовательских лицензий назначено.

maximumNumberOfSeats

integer

Это обязательное свойство, доступное только для подписок с планами FLEXIBLE или TRIAL . Это свойство задает максимальное количество лицензированных пользователей, разрешенных для подписки. Это количество может быть увеличено до максимального предела, определенного в договоре с торговым посредником. Минимальное количество — это текущее количество пользователей в учетной записи клиента.

licensedNumberOfSeats

integer

Поле только для чтения, содержащее текущее количество пользователей, которым назначена лицензия на продукт, указанный в skuId . Значение этого поля эквивалентно числовому количеству пользователей, возвращаемому методом API Enterprise License Manager: listForProductAndSku .

kind

string

Идентифицирует ресурс как настройку места подписки. Стоимость: subscriptions#seats

Настройки продления

Шаблон JSON для настроек продления подписки.

Представление JSON
{
  "renewalType": string,
  "kind": string
}
Поля
renewalType

string

Настройки продления годового плана обязательств. Для получения более подробной информации см. варианты продления в справочном центре администратора . При продлении подписки renewalType является обязательным.

kind

string

Идентифицирует ресурс как параметр продления подписки. Значение: subscriptions#renewalSettings

Методы

activate

 Активирует подписку, ранее приостановленную реселлером.

changePlan

 Обновляет план подписки.

changeRenewalSettings

 Обновляет настройки продления пользовательской лицензии.

changeSeats

 Обновляет настройки пользовательской лицензии подписки.

delete

 Отменяет, приостанавливает или переводит подписку в директ.

get

 Получает определенную подписку.

insert

 Создает или передает подписку.

list

 Списки подписок, которыми управляет торговый посредник.

startPaidService

 Немедленно перенесите 30-дневную бесплатную пробную подписку на подписку на платную услугу.

suspend

 Приостанавливает активную подписку.