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 会在订阅更新时发生更改，因此我们建议将此 ID 用作永久性数据的键。按照检索所有转销商订阅中的说明使用 subscriptionId。
skuId

string

必需的属性。skuId 是订阅中分配给客户的商品 SKU 的唯一系统标识符。如需了解此 API 版本中可用的产品和 SKU，请参阅产品和 SKU ID。
creationTime

string (int64 format)

creationTime 属性是创建订阅的日期。以毫秒为单位，使用纪元格式。请参阅纪元转换器示例。
kind

string

将资源标识为订阅。值：reseller#subscription
seats

object (Seats)

这是必需的属性。方案中的用户席位许可的数量和限制。
renewalSettings

object (RenewalSettings)

包年套餐承诺的续订设置。有关详情，请参阅管理员帮助中心中的续订选项。
purchaseOrderId

string

这是一个可选属性。此采购订单 (PO) 信息供转销商用来跟踪其公司的使用情况。如果指定了 purchaseOrderId 值，则该值会显示在 API 响应中，并会显示在帐单中。此属性最多可接受 80 个纯文本字符。
status

string

这是一个可选属性。
resourceUiUrl

string

指向管理控制台中“订阅”页面的网址。只读网址由 API 服务生成。如果您的客户端应用要求客户使用管理控制台中的“订阅”页面完成任务，系统就会使用此方法。
billingMethod

string

只读字段，返回订阅的当前结算方式。
suspensionReasons[]

string

只读字段，包含订阅的所有当前暂停原因的枚举。一个订阅可能会同时存在多个重叠的暂停原因。在解除所有待处理的暂停状态之前，订阅的STATUS为 SUSPENDED。

可能的选项包括：

  • PENDING_TOS_ACCEPTANCE - 客户尚未登录并接受 G Suite 转销的服务条款。
  • RENEWAL_WITH_TYPE_CANCEL - 客户的承诺已结束，服务在订阅期结束时取消了。
  • RESELLER_INITIATED - 由转销商调用的手动暂停服务。
  • TRIAL_ENDED - 客户的试用期已结束，未选择任何方案。
  • OTHER - 客户因内部 Google 原因（例如存在滥用行为或其他原因）被暂停帐号。
customerDomain

string

客户的主域名
dealCode

string

Google 针对订阅方案提供的折扣代码（上限为 100 个字符）。交易代码必须包含在 insert 个请求中，才能享受折扣价格。此属性是可选的，如果留空，则采用常规价格。
skuName

string

订阅中的客户 SKU 的只读产品外部显示名称。SKU 名称由 Google 自行决定。如需了解此 API 版本中可用的产品和 SKU，请参阅产品和 SKU ID。
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 - 免费方案专用于 Cloud Identity SKU，不产生任何费用。
plan.isCommitmentPlan

boolean

isCommitmentPlan 属性的布尔值会将方案标识为包年方案：

  • true - 订阅方案属于包年方案。
  • false - 该方案不是包年套餐。
plan.commitmentInterval

object

在此版本的 API 中，年度方案的间隔为一年。
plan.commitmentInterval.startTime

string (int64 format)

年度承诺方案的时间间隔，以毫秒为单位，使用 UNIX 纪元格式的毫秒数。startTime请参阅纪元转换器示例。
plan.commitmentInterval.endTime

string (int64 format)

年度承诺计划的时间间隔（以毫秒为单位），使用 UNIX 纪元格式，以毫秒为单位。endTime请参阅纪元转换器示例。
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 纪元格式的时间（以毫秒为单位）。
transferInfo.minimumTransferableSeats

integer

插入订阅时，这是此产品的转移订单中列出的最小席位数。例如，如果客户有 20 位用户，则转销商无法下达 15 个席位的转移订单。最少 20 个座位。
transferInfo.currentLegacySkuId

string

当前转销的订阅的 skuId。仅当客户使用旧版 SKU 进行订阅，并且订阅资源填充了为转移建议的 SKU 的 skuId 时，系统才会填充此值。

座位数

订阅席位的 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 中定义的产品分配的许可的当前用户数。此字段的值等于 Enterprise License Manager API 方法返回的用户数数值：listForProductAndSku。
kind

string

将资源标识为订阅席位设置。值：subscriptions#seats

RenewalSettings

用于续订设置的 JSON 模板。

JSON 表示法 
{
  "renewalType": string,
  "kind": string
}
字段
renewalType

string

包年套餐承诺的续订设置。有关详情，请参阅管理员帮助中心中的续订选项。续订时，renewalType 是必需属性。
kind

string

将资源标识为订阅续订设置。值：subscriptions#renewalSettings

方法

activate

 激活转销商之前暂停的订阅。

changePlan

 更新订阅方案。

changeRenewalSettings

 更新用户许可的续订设置。

changeSeats

 更新订阅的用户许可设置。

delete

 取消、暂停订阅或将订阅转移至直接订阅。

get

 获取特定订阅。

insert

 创建或转移订阅。

list

 由转销商管理的订阅列表。

startPaidService

 立即将 30 天的免费试用期订阅改为付费服务订阅。

suspend

 暂停有效订阅。