Method: purchases.subscriptions.cancel

• HTTP リクエスト
• パスパラメータ
• リクエストの本文
  • JSON 表現
• レスポンスの本文
• 認可スコープ
• CancellationType
• 試してみる

ユーザーの定期購入をキャンセルします。定期購入は有効期限まで有効です。クライアント ライブラリのサポートを強化するため、新しいバージョンは purchases.subscriptionsv2.cancel で利用できます。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用しています。

パスパラメータ

パラメータ
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 をご覧ください。これは、解約タイプが指定されていない場合のデフォルトの動作です。