Method: subscriptions.delete

取消、暫停或轉移訂閱項目。

HTTP 要求

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

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

路徑參數

參數
customerId

string

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

string

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

查詢參數

參數
deletionType

enum (DeletionType)

deletionType 查詢字串可用於取消、降級或暫停訂閱。

要求主體

要求主體必須為空白。

回應主體

用於表示任何 HTTP 主體的訊息；只能用於無法以 JSON 表示的酬載格式，例如未經處理的二進位檔或 HTML 網頁。

這個訊息可以用於要求及回應中的串流和非串流 API 方法。

這個訊息可以當做頂層要求欄位；想從網址或 HTTP 範本中將參數擷取至要求欄位，同時又想存取未經處理的 HTTP 主體時，這個做法就非常便利。

範例：

message GetResourceRequest {
  // A unique request id.
  string requestId = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

串流方法範例：

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

使用這個類型只會改變要求和回應主體的處理方式，所有其他功能的運作方式皆維持不變。

如果成功，回應會是一般 HTTP 回應，其格式由方法定義。

JSON 表示法 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
欄位
contentType

string

指定主體內容類型的 HTTP Content-Type 標頭值。
data

string (bytes format)

以原始二進位檔格式顯示 HTTP 要求/回應主體。

Base64 編碼字串。
extensions[]

object

應用程式專屬回應中繼資料。必須在串流 API 的第一個回應中進行設定。

含有任意類型欄位的物件。額外的 "@type" 欄位則包含能辨識類型的 URI。範例：{ "id": 1234, "@type": "types.example.com/standard/id" }。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。

DeletionType

列舉
deletion_type_undefined
cancel 立即取消訂閱。但不適用於 G Suite 訂閱方案。
transfer_to_direct

將訂閱直接轉移至 Google。 客戶會立即轉移至與 Google 的直接帳單關係，並在短時間內不會中斷服務。之後，客戶可以選擇使用信用卡直接向 Google 設定結帳資訊，也可以轉移至其他經銷商。