Stripe CLI

テスト環境で、コマンドラインから直接 Stripe のリソースを管理します。

Stripe CLI は開発者向けのツールであり、コマンドラインから直接、Stripe の組み込みを構築、テスト、管理できます。Stripe CLI を使用すると、Stripe API の呼び出し、Webhook の組み込みのテスト、アプリケーションの作成などの多数の一般的なタスクを簡単に実行できます。

ガイドを見ながら始めましょう

Stripe CLI を使ってみる

Stripe CLI を macOS、Windows、Linux にインストールして、まず、Developer Advocacy の YouTube 動画をご覧ください。

Stripe CLI のオートコンプリート機能を有効にする

オートコンプリート機能を有効にして、Stripe CLI でコマンドが自動入力されるようにします。

Stripe CLI キーと権限

Stripe CLI キー、ローカル側の保管場所、権限を確認できる場所についてご紹介します。

Stripe CLI をアップグレードする

Stripe CLI の最新の機能を利用できます。

リファレンスガイド

CLI および Stripe API の詳細については、リファレンスガイドをご覧ください。

Stripe にログインしてリクエストを認証する

ログインして Stripe ユーザーアカウントを認証し、「制限付きのキー」のセットを生成します。詳細については、Stripe CLI キーと権限をご覧ください。

Command Line

stripe login

キーボードの Enter キーを押し、ブラウザーでの認証プロセスを完了します。

Output
Your pairing code is: enjoy-enough-outwit-win
This pairing code verifies your authentication with Stripe.
Press Enter to open the browser or visit https://dashboard.stripe.com/stripecli/confirm_auth?t=THQdJfL3x12udFkNorJL8OF1iFlN8Az1 (^C to quit)

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

CLI で Stripe API を呼び出すと、すべてのリクエストで、ワークベンチで確認できるデフォルトの API バージョンが使用されます。CLI で異なる API バージョンを試すには、次のフラグを使用します。

フラグ	説明	例
`–stripe-version 2024-11-20.acacia`	CLI リクエストで `--stripe-version` フラグを使用して、API バージョンを指定します。	`stripe products create --name=“My Product” --stripe-version 2024-11-20.acacia`
`--latest`	CLI リクエストで `--latest` フラグを使用して、最新の API バージョンを指定します。	`stripe products create --name="My Product" --latest`

API バージョンのリストを表示することもできます。

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

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 に登録された公開 Webhook エンドポイントに送信されたイベントを、ローカルの Webhook エンドポイントに転送します。これにより、登録されたエンドポイントにイベントが読み込まれ、パスとその登録イベントが解析され、次にそのパスが --forward-to パスのローカルの Webhook エンドポイントに関連付けられます。Webhook の署名を確認している場合は、listen コマンドの初期出力から {{WEBHOOK_SIGNING_SECRET}} を使用します。

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

–help フラグを使用して、イベントカテゴリーで利用可能なすべてのイベントをリストに表示します。たとえば、Stripe Checkout の構築済みの購入ページで利用できるすべてのイベントを表示する場合には、以下を実行します。

Command Line
stripe trigger checkout --help

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

Create a product (商品の作成) への 1 つの API リクエストを作成します。

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

レスポンスオブジェクトの id 内で商品 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!

トリガーについて、詳細は Stripe のガイドをご覧ください。