はじめに
本記事では、Stripe CLIの概要から、よく使われるコマンドや活用方法など、幅広く機能を紹介します。
ローカル環境での開発・テスト時に非常に重宝するツールですので、Stripeを扱う方はぜひ導入を検討してみてください。
Stripe CLIとは
Stripe CLIは、Stripeアカウントと連携して以下のような操作をローカルで簡単に行えるコマンドラインツールです。
- ローカルでWebhookイベントを受信し、イベント処理を即時にテスト
- コマンドラインから支払い関連のイベントなどをトリガー
- Stripeアカウントのリソースを作成・取得・更新・削除
- ログのモニタリング
- イベント履歴の取得
開発・テスト段階でできるだけ早くフィードバックを得たい場合に重宝し、デバッグを効率化できます。
インストールと初期設定
インストール (macOS Homebrewの場合)
brew install stripe/stripe-cli/stripe
上記でStripe CLIをインストール可能です。他のOSの場合は公式ドキュメントを参照してください。
ログイン
StripeアカウントとCLIを連携するために、以下のコマンドを使ってログインします。表示されたペアリングコードをブラウザに入力し、認証する流れです。
stripe login
Your pairing code is: enjoy-enough-outwit-win
Press Enter to open the browser or visit ...
Webhookイベントの受信
ローカルリスナーの起動
以下のようにコマンドを実行すると、Webhookイベントをローカルに転送できます。
stripe listen --forward-to localhost:4242/webhook
StripeダッシュボードやStripe CLI上で発生したイベントは、localhost:4242/webhook で待ち受けるサーバに対してリアルタイムに通知されます。Webhook処理をローカルで検証したい場合に便利です。
イベントのトリガー
支払い成功イベント等を手動で発火させるには、以下のように trigger コマンドを使用します。
stripe trigger payment_intent.succeeded
これにより、成功した支払いイベントがStripeから送信されるので、受信や処理ロジックのテストを簡単に行えます。
主なコマンドと活用例
Stripe CLIには多彩なコマンドが用意されています。ここでは主な機能・コマンドの一部を紹介します。
1. リソース操作
stripe customers createstripe charges create --amount 2000 --currency jpy --customer cus_XXXX-
stripe subscriptions create
など、Stripe APIで行うリソース作成や更新、取得をコマンドラインから直接実行可能です。テスト用データを素早く追加したいときに便利です。
2. ログの監視
-
stripe logs tail
リアルタイムでリクエストログを確認できます。エラーやリクエストの状況を把握しやすく、原因追及・デバッグがスムーズになります。
3. イベントの確認
-
stripe events list
テスト/本番環境で発生したイベントのリストを取得して、Webhooksの送信状況やエラーを確認できます。
4. サンプルの取得
-
stripe samples create <サンプル名>
Stripe公式が用意したサンプルプロジェクトを一括でセットアップできます。決済フローなどを手っ取り早く試したい場合に役立ちます。
5. devモードでの開発補助
-
stripe dev
特定のサンプルを起動してローカル開発環境を自動で構築してくれます。Webhooksの設定などもまとめて行ってくれるため、導入がスピーディになります。
開発フローイメージ
以下は、Stripe CLIによる認証・Webhook受信・リソース操作を大まかに示したイメージです。
まとめ
Stripe CLIは、ローカルでのWebhook受信テストや支払い関連のイベント発火、ログのモニタリングなど、多彩な機能を持った強力なツールです。主なメリットは以下のとおりです。
-
Webhookのテストが容易:
stripe listenでローカル環境に即時送信 -
イベントの手動トリガー:
stripe triggerで支払い成功などを簡単に再現 - リソース操作やログ確認が簡単: テスト用のデータ作成やAPIログの監視を一つのCLIで完結
- サンプルプロジェクトやdevモード: 導入～開発のハードルを大幅に下げてくれる
Stripeでの決済やサブスクリプション実装などを効率的に進めたい場合は、ぜひStripe CLIを導入してみてください。複雑なWebhooksテストやログ解析をスピーディにこなせるようになり、開発効率が大きく向上します。
会社紹介
株式会社 Mosaica
最先端テクノロジーで社会課題を解決し、持続可能な未来を創造する IT カンパニー。
AI ソリューション、クラウド統合、DX 推進、経営コンサルティングなど包括的なサービスでビジネス変革を支援しています。
詳しくは 公式サイト までお気軽にご相談ください。
公式サイト： https://mosaica.co.jp/