REST Resource: subscriptions

資源：Subscription

訂閱項目的 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 產生的專屬 ID。在要求中，這個屬性可以是主要網域，也可以是 Google 產生的專屬 ID。
subscriptionId

string

subscriptionId 是訂閱 ID，每位客戶皆有專屬 ID。這是必要屬性。由於訂閱項目更新時，subscriptionId 會有所變更，因此建議您不要將這個 ID 做為永久性資料的鍵。請按照「擷取所有經銷商訂閱項目」一節所述，使用 subscriptionId。
skuId

string

必要屬性。skuId 是指派給訂閱項目客戶的產品 SKU 專屬系統 ID。如要瞭解這個版本的 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 天免費試用方案。如果未指派付款方案，試用期結束後，系統會暫停試用訂閱。呼叫 changePlan 會為試用方案指派付款方案，但不會啟用該方案。試用期結束後 (第 30 天)，系統會自動開始使用指派的付款方案，或是在呼叫 startPaidService 後立即開始。
  • FREE：免費方案僅適用於 Cloud Identity SKU，不會產生任何帳單費用。
plan.isCommitmentPlan

boolean

isCommitmentPlan 屬性的布林值可識別方案是否為年約方案：

  • true：訂閱方案是年約方案。
  • false：方案並非年約方案。
plan.commitmentInterval

object

在這個版本的 API 中，年約方案的間隔為一年。
plan.commitmentInterval.startTime

string (int64 format)

以 UNIX Epoch 格式，以毫秒為單位的年度承諾方案間隔 startTime。請參閱Epoch 轉換器範例。
plan.commitmentInterval.endTime

string (int64 format)

以 UNIX Epoch 格式，以毫秒為單位表示年度承諾方案的間隔 endTime。請參閱Epoch 轉換器範例。
trialSettings

object

G Suite 年約和彈性付款方案可享 30 天免費試用期。詳情請參閱 API 概念。
trialSettings.isInTrial

boolean

判斷訂閱方案是否處於 30 天免費試用期：

  • true：方案處於試用期。
  • false：方案並非試用方案。
trialSettings.trialEndTime

string (int64 format)

試用期結束的日期。這個值以 UNIX Epoch 格式以毫秒為單位。請參閱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

 暫停有效訂閱。