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，并且订阅资源填充了建议用于转移的 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

 暂停有效的订阅。