サブスクリプション
サブスクの解約
現在の請求期間終了時に自動更新しないよう、ユーザーのサブスクを解約予約します。
POST
概要
サブスクを解約します。実際のアクセス権は請求期間の終わりまで維持され、自動更新のみ停止されます。セッション認証(JWT アクセストークン)が必要です。サードパーティ連携: API キー認証で
POST /subscriptions/cancel/api を利用してください。認証
JWT アクセストークン。形式:
Bearer YOUR_ACCESS_TOKENレスポンスフィールド
解約予約が成功したかどうか。
読みやすいステータスメッセージ。
サブスクが終了する日時の ISO 8601(成功時のみ)。
エラーレスポンス
400
不正なリクエスト — キャンセル対象のアクティブ契約がない、または API 経由での解約ができない状態です。
401
未認証 — トークンが無効または未指定です。
解約時の動作
| 状況 | 挙動 |
|---|---|
| アクティブな契約がある | 期間末で解約予約となる |
| 既に解約済み | エラーを返す |
| 契約がない | エラーを返す |
| Stripe のサブスク ID がない | エラー(API ではキャンセル不可) |
再開
再開またはプラン変更は次から行えます。- Billing Portal(
/subscriptions/portal) - または現在の契約終了後に新規契約
運用上のヒント
- 確認ダイアログ: キャンセル前に必ず確認する
- 理由の収集: フィードバックのため離脱理由を聞く
- 離脱防止: 割引や一時停止の案内を検討する
- 明確な表示: アクセス権がいつ終わるかを明示する
POST /subscriptions/cancel/api
API キー認証でサブスクを解約します。サードパーティ連携向けです。認証
API キー認証が必要です。Authorization ヘッダーに API キーを付与します。
レスポンス
/subscriptions/cancel と同一です。