Method: subscriptions.changePlan

更新訂閱方案。使用這個方法,將 30 天試用方案或彈性訂閱方案更新為按月或按年付款的年約方案。

企劃書的更新方式會因企劃書和產品而異。詳情請參閱「管理訂閱」中的說明。

HTTP 要求

POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

這可以是客戶的主網域名稱,或客戶的專屬 ID。如果客戶的網域名稱有所變更,您就無法使用舊網域名稱存取客戶,但您隨時可以使用客戶的專屬 ID (由 API 傳回)。建議您在適用的情況下,將專屬 ID 儲存在系統中。

subscriptionId

string

這是必要屬性。subscriptionId 是訂閱 ID,每位客戶皆有專屬 ID。由於訂閱項目更新時,subscriptionId 會有所變更,因此建議您不要將此 ID 用於永久性資料的索引鍵。您可以使用擷取所有經銷商訂閱項目方法找到 subscriptionId

要求主體

要求主體包含 ChangePlanRequest 的例項。

回應主體

如果成功,回應主體會包含 Subscription 的執行例項。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/apps.order

詳情請參閱授權指南

ChangePlanRequest

subscriptions.changePlan rpc 要求的 JSON 範本。

JSON 表示法
{
  "kind": string,
  "planName": string,
  "seats": {
    object (Seats)
  },
  "purchaseOrderId": string,
  "dealCode": string
}
欄位
kind

string

指出資源是訂閱變更方案要求。值:subscriptions#changePlanRequest

planName

string

planName 屬性為必填欄位。這是訂閱項目的付款方案名稱。如要進一步瞭解 Google 付款方案,請參閱「API 概念」一文。

可能的值包括:

  • ANNUAL_MONTHLY_PAY - 年約方案,每月付款
  • ANNUAL_YEARLY_PAY - 年約方案 (按年付款)
  • FLEXIBLE - 彈性方案
  • TRIAL - 30 天免費試用方案

seats

object (Seats)

這是必要屬性。seats 屬性是使用者帳戶名額授權數。

purchaseOrderId

string

這是選用屬性。這項訂購單 (PO) 資訊可供轉售商用於追蹤公司使用情形。如果提供 purchaseOrderId 值,則會顯示在 API 回應和帳單中。這個屬性最多可接受 80 個半形字元。

dealCode

string

Google 核發的代碼 (最多 100 個字元),可用於訂閱方案的折扣價格。如要享有折扣費率,請務必在 changePlan 要求中加入優惠代碼。這是選用屬性。如果訂閱項目已加入特惠代碼,則可將這個屬性留空,系統仍會套用現有的折扣費率 (如果不為空白,請只提供訂閱項目中已有的特惠代碼)。如果訂閱項目從未加入特惠代碼,且這項屬性留空,系統會以定價計費。