Method: purchases.subscriptions.cancel

取消使用者的訂閱購買交易。訂閱方案在到期前仍有效。如要取得更完善的用戶端程式庫支援，請前往 purchases.subscriptionsv2.cancel 使用新版 API。

HTTP 要求

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel

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

路徑參數

參數
packageName

string

購買這項訂閱項目的應用程式套件名稱 (例如「com.some.thing」)。
subscriptionId

string

注意：自 2025 年 5 月 21 日起，訂閱項目 ID 為選填欄位，且不建議用於含有加購項目的訂閱項目。所購買訂閱項目的 ID (例如「monthly001」)。
token

string

購買訂閱項目時提供給使用者裝置的權杖。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "cancellationType": enum (CancellationType)
}
欄位
cancellationType

enum (CancellationType)

(選用步驟) 購買的訂閱方案取消類型。請注意，這個欄位僅支援 HTTP 要求。用戶端程式庫不支援這項功能。用戶端程式庫使用者可以改用 purchases.subscriptionsv2.cancel。

回應主體

如果成功，回應主體會留白。

範例

以下是要求範例：

curl -X POST \
  -H "Accept: application/json" \
  "https://androidpublisher.googleapis.com/androidpublisher/v3/applications/com.example.app/purchases/subscriptions/monthly.premium.plan/tokens/EXAMPLE_TOKEN_STRING_12345:cancel"

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/androidpublisher

CancellationType

開發人員要求取消的類型。

列舉
CANCELLATION_TYPE_UNSPECIFIED 未指定取消類型。
USER_REQUESTED_STOP_RENEWALS 使用者要求取消訂閱，但可以還原訂閱方案。這項操作只會停止續訂下個週期。如果是分期付款訂閱方案，使用者仍須完成合約期。如要進一步瞭解續訂和付款事宜，請參閱 https://developer.android.com/google/play/billing/subscriptions#installments
DEVELOPER_REQUESTED_STOP_PAYMENTS 開發人員要求取消訂閱，且無法復原。系統會停止收取下期費用。如果使用者是分期付款訂閱，則無須支付下期款項，且合約期將結束。如要進一步瞭解續訂和付款，請參閱 https://developer.android.com/google/play/billing/subscriptions#installments。如果未指定取消類型，系統會預設採用這種做法。