サブスクリプション
サブスク用 Checkout の作成
プラン契約のための Stripe Checkout セッションを作成します。
POST
概要
プランへの登録のため Stripe Checkout セッションを作成します。決済完了用にユーザーへリダイレクトすべき URL を返します。セッション認証(JWT アクセストークン)が必要です。サードパーティ連携: API キー認証で
POST /subscriptions/checkout/api を利用してください。認証
string
必須
JWT アクセストークン。形式:
Bearer YOUR_ACCESS_TOKENリクエストボディ
string
必須
契約するプラン ID。次のいずれかです:
starter、professional、business、agency。string
デフォルト:"monthly"
請求頻度。
monthly または yearly。string
決済成功後のリダイレクト URL。既定はアプリのダッシュボードです。
string
ユーザーが決済をキャンセルした場合のリダイレクト URL。既定は料金ページです。
レスポンスフィールド
string
Stripe Checkout セッション ID。後からセッションを検証する際に利用できます。
string
決済ページへユーザーを転送する URL。Stripe ホストの Checkout です。
object
選択されたプランの詳細。
Checkout の流れ
- セッション作成: 希望プランで本エンドポイントを呼び出す
- ユーザーを転送: 返却された
urlへ誘導する - 決済処理: ユーザーが Stripe 上で支払いを完了する
- Webhook: Stripe が Webhook で通知する
- 成功後の転送: ユーザーが
successUrlへリダイレクトされる - 検証(任意):
/subscriptions/currentで契約状態を確認する
エラーレスポンス
不正なリクエスト — 無効なプラン ID、または既にアクティブな契約がある場合など。
未認証 — トークンが無効または未指定です。
既にアクティブな契約がある場合は Checkout ではなく、請求ポータル(
/subscriptions/portal)からプラン変更する必要があります。POST /subscriptions/checkout/api
API キー認証で Stripe Checkout セッションを作成します。サードパーティ連携向けです。認証
API キー認証が必要です。Authorization ヘッダーに API キーを付与します。
リクエストボディ
/subscriptions/checkout と同一です。
レスポンス
/subscriptions/checkout と同一です。