Skip to main content
POST

概要

Stripe Customer Portal のセッションを作成します。ユーザーはそこで次の操作ができます。
  • 支払い方法の更新
  • 請求履歴の確認
  • プラン変更
  • 請求書のダウンロード
  • 契約の解約
セッション認証(JWT アクセストークン)が必要です。
サードパーティ連携: API キー認証で POST /subscriptions/portal/api を利用してください。

認証

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

リクエストボディ

string
ポータル終了後のリダイレクト URL。既定はアプリのダッシュボードです。

レスポンスフィールド

string
ユーザーがアクセスする URL。Stripe がホストする Billing Portal です。

ポータルでできること

Stripe Customer Portal ではユーザーは次が行えます。

エラーレスポンス

不正なリクエスト — 請求用アカウントが見つからない場合。先に購入が必要です。
未認証 — トークンが無効または未指定です。
Billing Portal は、過去に購入済みまたはアクティブな契約があるユーザーのみ利用できます。新規ユーザーは Checkout エンドポイントを利用してください。

POST /subscriptions/portal/api

API キー認証で Stripe Customer Portal セッションを作成します。サードパーティ連携向けです。

認証

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

リクエストボディ

/subscriptions/portal と同一です。

レスポンス

/subscriptions/portal と同一です。

運用上のヒント

  • 設定へのリンク: アプリ設定に「請求を管理」ボタンを置く
  • Checkout 後: 契約購入直後はポータルへ誘導するとよい
  • サポート: 請求に関するセルフサービスとしてポータルを案内する