Skip to main content
POST

概要

サブスクを解約します。実際のアクセス権は請求期間の終わりまで維持され、自動更新のみ停止されます。セッション認証(JWT アクセストークン)が必要です。
サードパーティ連携: API キー認証で POST /subscriptions/cancel/api を利用してください。
この操作は期間末での解約を予約します。currentPeriodEnd まではサービスは利用できます。即時停止が必要な場合は Billing Portal を利用してください。

認証

string
必須
JWT アクセストークン。形式: Bearer YOUR_ACCESS_TOKEN

レスポンスフィールド

boolean
解約予約が成功したかどうか。
string
読みやすいステータスメッセージ。
string
サブスクが終了する日時の ISO 8601(成功時のみ)。

エラーレスポンス

不正なリクエスト — キャンセル対象のアクティブ契約がない、または API 経由での解約ができない状態です。
未認証 — トークンが無効または未指定です。

解約時の動作

再開

再開またはプラン変更は次から行えます。
  1. Billing Portal(/subscriptions/portal
  2. または現在の契約終了後に新規契約

運用上のヒント

  • 確認ダイアログ: キャンセル前に必ず確認する
  • 理由の収集: フィードバックのため離脱理由を聞く
  • 離脱防止: 割引や一時停止の案内を検討する
  • 明確な表示: アクセス権がいつ終わるかを明示する

POST /subscriptions/cancel/api

API キー認証でサブスクを解約します。サードパーティ連携向けです。

認証

API キー認証が必要です。Authorization ヘッダーに API キーを付与します。

レスポンス

/subscriptions/cancel と同一です。