擷取訂閱項目後,您可以使用 成功回應 變更訂閱狀態 或更新訂閱項目本頁將重點說明幾種方法 擷取及更新訂閱項目
擷取訂閱項目
如要擷取成功訂購或轉移的訂閱項目,請使用
後續 GET
HTTP 要求。
GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID
更改下列內容:
CUSTOMER_ID
:客戶的主網域 名稱或客戶專屬 IDSUBSCRIPTION_ID
:訂閱項目 ID, 每個客戶都是獨一無二的您可以使用 擷取所有經銷商訂閱方法。
這項作業在要求主體中沒有參數。
成功的回應會傳回 HTTP 200
狀態
程式碼和訂閱項目設定。在以下範例回應中,
isInTrial
有 false
,但沒有任何房源
trialEndTime
資源,代表這位客戶從未出現在
訂閱這個方案可免費試用 30 天。
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"billingMethod": "ONLINE",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "RENEW_CURRENT_USERS_MONTHLY_PAY"
},
"purchaseOrderId": "example.com_annual_1",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
}
擷取客戶的所有訂閱
擷取特定經銷商客戶過去的所有訂閱
成功訂購或轉移,請使用下列 GET
HTTP 要求並
包含授權權杖:
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER
更改下列內容:
CUSTOMER_ID
:客戶的主網域 名稱或客戶專屬 IDSTART_DATE
:開始日期,格式為YYYY-MM-DD
。MAX_NUMBER
:傳回的結果數量上限 回應頁面。
這項作業在要求主體中沒有參數。
成功的回應會傳回 HTTP 200
狀態碼和
客戶的訂閱和設定訂閱項目清單可能包括
無法透過這個版本的 Reseller API 管理的產品。
如果您並未管理這位客戶,403 "Forbidden"
錯誤就會發生
。
擷取客戶的所有可轉移訂閱
如要擷取客戶可能產生的所有訂閱
已轉移至經銷商的管理範圍,請使用下列 GET
HTTP 要求
並附上授權權杖
customerId
是必要項目,而且是客戶的專屬 ID,
擷取經銷商客戶帳戶。
customerAuthToken
是客戶提供的轉移權杖,
。直至客戶的產生後,
30 天。如要進一步瞭解客戶如何產生權杖,請參閱
將 Google Workspace 帳戶轉移給經銷商。
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER
更改下列內容:
CUSTOMER_ID
:客戶的主網域 名稱或客戶專屬 IDAUTH_TOKEN
:您的轉移權杖是由您的 您的經銷商 ID 專屬的電子郵件地址。可以在 效期為 30 天。如要進一步瞭解客戶 產生權杖後 將 Google Workspace 帳戶轉移給經銷商。 如果這個值無效或已過期,API 回應會傳回403 "Forbidden"
個錯誤。START_DATE
:開始日期,格式為YYYY-MM-DD
。MAX_NUMBER
:傳回的結果數量上限 回應頁面。
這項作業在要求主體中沒有參數。
成功的回應會傳回 HTTP 200
狀態碼和
客戶在轉移到期日前的可轉移訂閱
權杖和轉移訂單中所需的帳戶名額下限。客戶
可能包含其他無法轉移的訂閱項目。
{
"kind": "reseller#subscriptions",
"subscriptions": [
{
"kind": "subscriptions#subscription",
"customerId": "custId-6543",
"subscriptionId": "432",
"skuId": "1010020028",
"billingMethod": "ONLINE",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10,
"maximumNumberOfSeats": 500,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"transferInfo": {
"transferabilityExpirationTime": "1333183980142",
"minimumTransferableSeats": "20"
},
"purchaseOrderId": "PO_890",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
},
{
"kind": "subscriptions#subscription",
"customerId": "custId-6543",
"subscriptionId": "140",
"skuId": "1010020028",
"creationTime": "1329389322728",
"plan": {
"planName": "FLEXIBLE",
"isCommitmentPlan": false
},
"seats": {
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 50
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false,
"trialEndTime": "1331877480016"
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"transferInfo": {
"transferabilityExpirationTime": "1333183780159",
"minimumTransferableSeats": "10"
},
"purchaseOrderId": "",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
},
],
"nextPageToken": "token"
}
如果您打算使用批次操作來轉移這些訂閱項目
作業,轉移所有訂閱項目。轉移每個訂閱項目
就會發生錯誤。此外,批次作業只能轉移
狀態為「ACTIVE
」的訂閱項目。若需更多資訊,請參閲
轉移訂閱項目。
擷取所有經銷商訂閱
擷取經銷商訂購或轉移成功的所有內容
訂閱項目,請使用以下 GET
HTTP 要求並提供授權權杖。
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER
更改下列內容:
PREFIX
:客戶名稱的開頭, 適當訂閱TOKEN
:可識別 伺服器應傳回的結果MAX_NUMBER
:傳回的結果數量上限 回應頁面。
這項作業可以使用 OAuth 唯讀存取權範圍。
customerNamePrefix
、pageToken
和 maxResults
是選用查詢字串。
以下範例會擷取經銷商擁有的所有訂閱 名稱開頭為「exam」的客戶:
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam
{
"kind": "reseller#subscriptions",
"subscriptions": [
{
"kind": "subscriptions#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"billingMethod": "ONLINE",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"purchaseOrderId": "PO_135",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
},
{
"kind": "subscriptions#subscription",
"customerId": "custId-5678",
"subscriptionId": "1404686",
"skuId": "1010020028",
"billingMethod": "ONLINE",
"creationTime": "1329389322728",
"plan": {
"planName": "FLEXIBLE",
"isCommitmentPlan": false
},
"seats": {
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 50,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false,
"trialEndTime": "1331877480016"
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "AUTO_RENEW"
},
"purchaseOrderId": "",
"status": "ACTIVE",
"resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
"skuName": "Google Workspace Business Standard"
},
],
"nextPageToken": "token"
}
更新訂閱方案
Google Workspace 方案的更新因方案而異。更新前的準備 建議您考慮下列事項:
建立訂閱項目後,客戶符合相關條件, 訂閱方案可以是 30 天試用期。靈活彈性和年約 承諾使用付款方案可以是 30 天免費試用期。在試用期間 可將訂閱項目的付款方案改為彈性或按年方案 查看最新的承諾使用合約但試用期結束後,方案 並遵循相同的規則更新企劃書 個訂閱項目有效的方案。如要立即將試用訂閱轉換為 有效企劃書 在 30 天免費試用期間啟用付費服務。 如要進一步瞭解 30 天試用資訊和客戶資格條件,請參閱 管理員說明中心。
您可以將彈性方案更新為年約方案。
無法更新年約方案。
部分方案僅適用於部分產品。如要進一步瞭解 產品採用的方案,請參閱 產品與SKU。
如何將 30 天試用期或彈性方案改成年約方案
合約方案,請使用下列 POST
HTTP 要求:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan
更改下列內容:
CUSTOMER_ID
:客戶的主網域 名稱或客戶專屬 IDSUBSCRIPTION_ID
:訂閱項目 ID, 每個客戶都是獨一無二的您可以使用 擷取所有經銷商訂閱方法。
以下範例會使用 subscriptionId
更新訂閱項目
這個值為 123customerId
為 C0123456。
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan
要求主體包含下列內容:
{
"kind": "reseller#changePlanRequest",
"planName": "ANNUAL_MONTHLY_PAY",
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10
},
"purchaseOrderId": "123_March2012"
}
成功的回應會傳回 HTTP 201
狀態碼,並傳回更新後的
訂閱方案設定:
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 10,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"purchaseOrderId": "123_March2012",
"status": "ACTIVE",
"skuName": "Google Workspace Business Standard"
}
更新訂閱項目的帳戶名額
更新年約方案的訂閱項目採用不同的訂閱方案 資源數量,而不是更新 Google Workspace 彈性方案的訂閱項目。
更新年約方案訂閱方案的帳戶名額
如要更新年約方案訂閱的使用者授權設定,請使用下列操作
POST
HTTP 要求:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats
更改下列內容:
CUSTOMER_ID
:客戶的主網域 名稱或客戶專屬 IDSUBSCRIPTION_ID
:訂閱項目 ID, 每個客戶都是獨一無二的您可以使用 擷取所有經銷商訂閱方法。
以下範例會使用 123 subscriptionId
更新訂閱項目。
customerId
為 C0123456。要求主體會因
方案類型:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats
Google Workspace 年約方案訂閱方案的訂閱方案會使用這個要求主體:
更新使用者授權數量。numberOfSeats
值為
。舉例來說,假設您先前擁有 10 個使用者授權,
客戶訂購 5 個新授權,
numberOfSeats
為 15,如以下範例所示:
{
"kind": "subscriptions#seats",
"numberOfSeats": 15
}
更新彈性方案訂閱項目的帳戶名額
Google Workspace 彈性方案的訂閱項目使用要求主體更新
使用者授權。maximumNumberOfSeats
值是
現有授權和新授權。這是使用者人數上限
授權。
{
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15
}
成功的回應會傳回 HTTP 201
狀態碼,且
訂閱授權設定:
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"plan": {
"planName": "FLEXIBLE",
"isCommitmentPlan": false
},
"seats": {
"kind": "subscriptions#seats",
"maximumNumberOfSeats": 15,
"licensedNumberOfSeats": 10
},
"trialSettings": {
"isInTrial": false
},
"skuName": "Google Workspace Business Standard"
}
更新訂閱項目的續訂設定
如要更新年約訂閱項目的續約設定,請使用
下列 POST
HTTP 要求:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings
更改下列內容:
CUSTOMER_ID
:客戶的主網域 名稱或客戶專屬 IDSUBSCRIPTION_ID
:訂閱項目 ID, 每個客戶都是獨一無二的您可以使用 擷取所有經銷商訂閱方法。
要求主體範例如下:
{
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}
renewalType
屬性的值可以是下列任一種:
AUTO_RENEW_YEARLY_PAY
:年約方案的週期結束時, 透過ANNUAL_YEARLY_PAY
相同的numberOfSeats
。AUTO_RENEW_MONTHLY_PAY
:年約方案的約期結束時 自動續訂型訂閱項目的方案,如 設有相同numberOfSeats
的ANNUAL_MONTHLY_PAY
。RENEW_CURRENT_USERS_YEARLY_PAY
:年約方案的約期結束時 ,請以ANNUAL_YEARLY_PAY
的身分續訂訂閱項目的方案,但使用 目前活躍使用者授權總數。此為預設值 有效年約方案 (按年付費)。RENEW_CURRENT_USERS_MONTHLY_PAY
:年約方案的約期結束時 ,請以ANNUAL_MONTHLY_PAY
的身分續訂訂閱項目的方案,但使用 目前活躍使用者授權總數。此為預設值 為有效的年約方案 (按月付款) 設定。RENEW_ON_PROPOSED_OFFER
:目前合約方案結束時 時間間隔,以最新續約提案續約,in numberOfSeats 為數字 目前活躍使用者授權數量或提議優惠承諾使用合約 (以何者為準) 更高。SWITCH_TO_PAY_AS_YOU_GO
:年約方案的約期結束時 將年約方案變更為彈性方案。CANCEL
:年約方案的間隔結束後,訂閱項目 遭到停權。若要瞭解如何解除停權狀態,請參閱 管理員說明中心。
成功的回應會傳回 HTTP 201
狀態碼,且
續訂設定:
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 15,
"licensedNumberOfSeats": 15
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"skuName": "Google Workspace Business Standard"
}
從免費試用訂閱方案啟用付費服務
如何立即將 30 天免費試用訂閱轉換為付費服務
(如果已為試用設定付款方案)
訂閱,請使用以下 POST
HTTP 要求。
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService
更改下列內容:
CUSTOMER_ID
:客戶的主網域 名稱或客戶專屬 IDSUBSCRIPTION_ID
:訂閱項目 ID, 每個客戶都是獨一無二的您可以使用 擷取所有經銷商訂閱方法。
以下範例中的 C0123456 是 customerId
,
subscriptionId
值 123:
POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService
這項作業在要求主體中沒有參數。
成功的回應會傳回 HTTP 201
狀態碼和更新後的訂閱設定:
{
"kind": "reseller#subscription",
"customerId": "C0123456",
"subscriptionId": "123",
"skuId": "1010020028",
"creationTime": "1331647980142",
"plan": {
"planName": "ANNUAL",
"isCommitmentPlan": true,
"commitmentInterval": {
"startTime": "1331647980142",
"endTime": "1363183980142"
}
},
"seats": {
"kind": "subscriptions#seats",
"numberOfSeats": 15,
"licensedNumberOfSeats": 15
},
"trialSettings": {
"isInTrial": false
},
"renewalSettings": {
"kind": "subscriptions#renewalSettings",
"renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
},
"skuName": "Google Workspace Business Standard"
}
將訂閱項目升級或降級
您無法在約期屆滿時將年約方案降級,而且無法降級
請透過續約設定安排降級期限我們建議您為
續約設定切換至 FLEXIBLE
,然後在續約後降級。
如要升級或降級訂閱項目,請建立新的訂閱項目
存取要升級或降級的 skuId
。
POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
更改下列內容:
CUSTOMER_ID
:客戶的主網域 名稱或客戶專屬 ID
這項呼叫會終止先前的訂閱項目,並建立新的訂閱項目。
進一步瞭解 升級與降級 深入瞭解產品。