Stripe CLI を使用する

コマンドラインから Stripe 統合をビルド、テスト、管理します。

Stripe CLI を使用すると、コマンドラインから Stripe 統合をビルド、テスト、管理できます。CLI を使用すると、Stripe リソースの作成と管理、Webhook イベントのトリガー、リアルタイム API リクエストログのストリーミング、ローカル開発環境へのイベントの転送を行うことができます。

リクエストの実行時に API バージョンを指定する

CLI で Stripe API を呼び出すと、すべてのリクエストでデフォルトの API バージョンが使用されます。これは Workbench で識別できます。CLI でさまざまな API バージョンを試すには、次のフラグを使用します。

フラグ	Description	例
`--stripe-version 2025-08-27.basil`	CLI リクエストで `--stripe-version` フラグを使用して、API バージョンを指定します。	`stripe products create --name=“My Product” --stripe-version 2025-08-27.basil`
`--latest`	CLI リクエストで `--latest` フラグを使用して、最新の API バージョンを指定します。	`stripe products create --name="My Product" --latest`

また、API versions のリストを表示することもできます。

リクエストログをストリーミングする

stripe logs tail コマンドを使用して API リクエストログをストリーミングします。このウィンドウは開いたままにしておいてください。API コールでエラーが発生すると、この端末から API エラーメッセージとエラーの理由が返されます。

Command Line
stripe logs tail

ローカルの Webhook エンドポイントにイベントを転送する

--forward-to フラグを使用して、サンドボックス 内のすべての Stripe イベントをローカル Webhook エンドポイントに送信します。HTTPS 証明書の検証を無効にするには、--skip-verify フラグを使用します。

Command Line
stripe listen --forward-to localhost:4242/webhooks

Output
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)

特定のイベントをカンマ区切りのリストで転送するには、--events フラグを使用します。

Command Line
stripe listen --events payment_intent.created,customer.created,payment_intent.succeeded,charge.succeeded,checkout.session.completed,charge.failed \
  --forward-to localhost:4242/webhook

すでに Stripe にエンドポイントを登録している場合は、--load-from-webhooks-api と --forward-to フラグを使用できます。

Command Line
stripe listen --load-from-webhooks-api --forward-to localhost:4242

このコマンドは、Stripe に登録された public Webhook エンドポイントに送信されたイベントを、local Webhook エンドポイントに転送します。登録されたエンドポイントを読み込み、パスとその登録イベントを解析し、次にそのパスを --forward-to パス内のローカル Webhook エンドポイントに追加します。Webhook 署名を確認している場合は、listen コマンドの初期出力から {{WEBHOOK_SIGNING_SECRET}} を使用します。

利用可能なすべてのイベントを表示する

help flag (--help) を使用して、イベントカテゴリで発生する可能性のあるすべてのイベントを一覧表示します。たとえば、Stripe Checkout の事前構築済みチェックアウトページのすべての可能なイベントを一覧表示するには:

Command Line
stripe trigger checkout --help

1 回限りの商品と価格を作成する

Create a product への単一の API リクエストを作成します。

Command Line
stripe products create \
--name="My First Product" \
--description="Created with the Stripe CLI"

レスポンスオブジェクト内の商品識別子 (id) を探してください。次のステップのために保存してください。すべてが正常に機能した場合、コマンドラインには次のレスポンスが表示されます。
```
{
  "id": "prod_LTenIrmp8Q67sa",
  "object": "product",
```
Create a price を呼び出して 30 USD の価格を設定します。product のプレースホルダーを商品 ID (例: prod_LTenIrmp8Q67sa) に置き換えてください。
Command Line
```
stripe prices create \
  --unit-amount=3000 \
  --currency=usd \
  --product={{PRODUCT_ID}}
```
すべて正常に機能する場合、コマンドラインに以下のレスポンスが表示されます。
```
{
  "id": "price_1KzlAMJJDeE9fu01WMJJr79o",
  "object": "price",
```

テスト中に Webhook イベントをトリガーする

checkout.session.completed イベントをトリガーし、チェックアウトセッションが正常に完了したときに生成される API オブジェクトを作成します。

Command Line
stripe trigger checkout.session.completed

stripe listen 端末には、以下の出力が表示されます。

Command Line

Setting up fixture for: checkout_session
Running fixture for: checkout_session
Setting up fixture for: payment_page
Running fixture for: payment_page
Setting up fixture for: payment_method
Running fixture for: payment_method
Setting up fixture for: payment_page_confirm
Running fixture for: payment_page_confirm
Trigger succeeded!