メインコンテンツへスキップ
サブスクリプション注文エンドポイントにより、定期課金注文の作成とライフサイクルの管理が可能です。サブスクリプションはチェックアウトセッション(productType: "subscription")を通じて作成され、キャンセルとステータス遷移によって管理されます。

サブスクリプションステータス値

ステータス説明
pendingサブスクリプション作成済み、初回支払い待ち
active有効で通常課金中
trialing無料トライアル期間中
cancelingキャンセルリクエスト済み、期間終了まで有効
past_due支払い失敗、リトライ中
canceledサブスクリプション終了、以降の課金なし
expiredサブスクリプション期限切れ

エンドポイント

サブスクリプション注文の作成

チェックアウトセッションを使用してサブスクリプション注文を作成します。

サブスクリプションのキャンセル

有効または保留中のサブスクリプションをキャンセルします。

近日公開

以下のエンドポイントは計画中ですが未実装です(現在は 501 Not Implemented を返します):
  • 商品の変更 (POST /v1/actions/subscription-order/change-product) — サブスクリプションを別の商品にアップグレードまたはダウングレードします。
  • サブスクリプションの再有効化 (POST /v1/actions/subscription-order/reactivate-order) — キャンセルされたサブスクリプションを再有効化します。