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 продукта, назначенный клиенту в подписке. Для продуктов и SKU, доступных в этой версии API, см. Идентификаторы продуктов и SKU .

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 продукта, назначенного клиенту в подписке. Названия SKU могут быть изменены по усмотрению Google. Информацию о продуктах и ​​SKU, доступных в этой версии API, см. в разделе «Идентификаторы продуктов и SKU» .

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 Epoch. См. пример конвертера эпох .

plan.commitmentInterval.endTime

string ( int64 format)

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

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

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

get

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

insert

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

list

 Списки подписок, управляемых реселлером.

startPaidService

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

suspend

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