Method: purchases.subscriptions.cancel

取消用户购买的订阅。订阅保持有效，直至到期。新版本可在 purchases.subscriptionsv2.cancel 中找到，以提供更好的客户端库支持。

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 日起，对于包含加购项的订阅，subscriptionId 不再是必需的，也不建议使用。所购买订阅的 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。如果未指定取消类型，则这是默认行为。