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 属性是订阅的创建日期。以毫秒为单位，采用 Epoch 格式。请参阅示例 Epoch 转换器。
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 的外部只读显示名。Google 可能会自行决定对 SKU 名称进行更改。如需了解此版本 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)

包年套餐的间隔 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 纪元格式。请参阅示例 Epoch 转换器。
transferInfo

object

订阅的只读转移相关信息。如需了解详情，请参阅为客户检索可转移的订阅。
transferInfo.transferabilityExpirationTime

string (int64 format)

转移令牌或转移意图的过期时间。时间以毫秒为单位，使用 UNIX Epoch 格式。
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

 暂停有效订阅。