資源:訂閱
訂閱項目的 JSON 範本。
JSON 表示法 |
---|
{ "customerId": string, "subscriptionId": string, "skuId": string, "creationTime": string, "kind": string, "seats": { object ( |
欄位 | |
---|---|
customerId |
系統一律會在回應中傳回這個屬性,做為 Google 產生的專屬 ID。在要求中,這項資源可以是主網域或 Google 產生的專屬 ID。 |
subscriptionId |
|
skuId |
必要屬性。 |
creationTime |
|
kind |
將資源識別為訂閱項目。值: |
seats |
這是必要屬性。方案中使用者名額授權數量和限制。 |
renewalSettings |
年約方案的續約設定。如需瞭解詳情,請前往管理員說明中心查看續約選項。 |
purchaseOrderId |
這是選用屬性。這份訂購單 (PO) 資訊可供經銷商用於追蹤公司使用情形。指定 |
status |
這是選用屬性。 |
resourceUiUrl |
管理控制台中「訂閱」頁面的網址。唯讀網址是由 API 服務產生。如果您的客戶應用程式需要使用管理控制台中的「訂閱」頁面來完成工作,就會使用這個選項。 |
billingMethod |
唯讀欄位,用於傳回訂閱項目目前的付款方式。 |
suspensionReasons[] |
唯讀欄位,當中含有訂閱項目目前所有停權原因的列舉。訂閱項目的並行原因可能有很多、重疊。訂閱
|
customerDomain |
客戶的主網域名稱 |
dealCode |
Google 針對訂閱方案提供折扣價格的代碼 (最多 100 個字元)。優惠代碼必須包含在 |
skuName |
訂閱中客戶指派給產品 SKU 的唯讀外部顯示名稱。Google 可自行斟酌變更 SKU 名稱。如要瞭解這個 API 版本提供的產品和 SKU,請參閱「產品與 SKU ID」。 |
plan |
必須提供 |
plan.planName |
必須提供
|
plan.isCommitmentPlan |
|
plan.commitmentInterval |
在這個版本的 API 中,每年的承諾使用方案為一年。 |
plan.commitmentInterval.startTime |
使用 UNIX Epoch 紀元格式的年約方案承諾使用價格 (以毫秒為單位) |
plan.commitmentInterval.endTime |
使用 UNIX Epoch 紀元格式的年度承諾使用合約 (以毫秒為單位) |
trialSettings |
G Suite 年約方案 (彈性方案) 和彈性付款方案皆可申請 30 天。詳情請參閱 API 概念。 |
trialSettings.isInTrial |
決定訂閱項目是否處於 30 天的免費試用期:
|
trialSettings.trialEndTime |
試用期的結束日期。這個值以 UNIX Epoch 紀元格式表示 (以毫秒為單位)。請參閱 Epoch 轉換工具範例。 |
transferInfo |
訂閱項目的唯讀轉移相關資訊。詳情請參閱為客戶擷取可轉移的訂閱。 |
transferInfo.transferabilityExpirationTime |
轉移權杖或轉移意圖的到期時間。使用 UNIX Epoch 紀元格式的時間 (以毫秒為單位)。 |
transferInfo.minimumTransferableSeats |
插入訂閱項目時,這是指這項產品的訂購單中所列的帳戶名額下限。舉例來說,如果客戶有 20 位使用者,經銷商最多只能訂購 15 個帳戶名額。至少要有 20 個帳戶名額。 |
transferInfo.currentLegacySkuId |
目前經銷的 |
座位數
訂閱座位的 JSON 範本。
JSON 表示法 |
---|
{ "numberOfSeats": integer, "maximumNumberOfSeats": integer, "licensedNumberOfSeats": integer, "kind": string } |
欄位 | |
---|---|
numberOfSeats |
此為必要屬性,僅適用於設有 |
maximumNumberOfSeats |
這是選用屬性,僅適用於訂閱「 |
licensedNumberOfSeats |
唯讀欄位,包含目前指派給 |
kind |
將資源視為訂閱座椅設定。值: |
RenewalSettings
訂閱續約設定的 JSON 範本。
JSON 表示法 |
---|
{ "renewalType": string, "kind": string } |
欄位 | |
---|---|
renewalType |
年約方案的續約設定。如需瞭解詳情,請前往管理員說明中心查看續約選項。續訂時, |
kind |
標識資源訂閱設定。值: |
方法 |
|
---|---|
|
啟用經銷商先前遭到停權的訂閱。 |
|
更新訂閱方案。 |
|
更新使用者的授權設定。 |
|
更新訂閱項目的使用者授權設定。 |
|
取消、暫停或將訂閱轉移給直接客戶。 |
|
取得特定訂閱項目。 |
|
建立或轉移訂閱。 |
|
轉移至經銷商管理的訂閱清單。 |
|
立即將 30 天的免費試用訂閱轉換為付費服務訂閱。 |
|
可將有效的訂閱停權。 |