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 天方案，如未指派付款方案，試用期間的訂閱將在第 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

 將有效訂閱項目停權。