The Stripe CLI helps you build, test, and manage your Stripe integration right from the terminal.

With the CLI, you can:

• Securely test webhooks without relying on third-party tunneling software.
• Trigger webhook events to easily test your integration.
• Tail API request logs in real time.
• Create, retrieve, update, and delete API objects.

Follow the steps below to get started with the Stripe CLI.

Step 1: Install the Stripe CLI

brew install stripe/stripe-cli/stripe

sudo apt-key adv --keyserver hkp://pool.sks-keyservers.net:80 --recv-keys 379CE192D401AB61

echo "deb https://dl.bintray.com/stripe/stripe-cli-deb stable main" | sudo tee -a /etc/apt/sources.list

sudo apt-get update

sudo apt-get install stripe

wget https://bintray.com/stripe/stripe-cli-rpm/rpm -O bintray-stripe-stripe-cli-rpm.repo && sudo mv bintray-stripe-stripe-cli-rpm.repo /etc/yum.repos.d/

sudo yum update

sudo yum install stripe

scoop bucket add stripe https://github.com/stripe/scoop-stripe-cli.git

scoop install stripe

docker run --rm -it stripe/stripe-cli latest

Step 2: Link your Stripe account

Once you have the Stripe CLI installed, run stripe login in the command line to generate a pairing code to link to your Stripe account. Press Enter to launch your browser and log in to your Stripe account to allow access. The generated API key is valid for 90 days. You can modify or delete the key under API Keys in the Dashboard.

stripe login
Your pairing code is: humour-nifty-finer-magic
Press Enter to open up the browser (^C to quit)

If you want to use an existing API key, use the --api-key flag:

stripe login --api-key `{{TEST_API_KEY}}`
Your pairing code is: humour-nifty-finer-magic
Press Enter to open up the browser (^C to quit)

Step 3: Listen for events

To confirm you can view webhook events from your Stripe account, run stripe listen:

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

Events are only created once specific actions are taken, so you might not see any events until you create a new object. In a new command prompt, trigger a payment_intent.created event:

stripe trigger payment_intent.created

You should see some information about the event in the command prompt where you ran the stripe listen command:

stripe listen
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)
INFO Received event: '{{WEBHOOK_EVENT_ID}}' [type: payment_intent.created]

Step 4: Forward events to your server

You can also use the Stripe CLI to forward events to your server with the --forward-to flag:

stripe listen --forward-to localhost:5000/hooks
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)

As in the previous step, events from your account show up in the command prompt output along with the response from your server:

stripe listen --forward-to localhost:5000/hooks
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)
INFO Received event: '{{WEBHOOK_EVENT_ID}}' [type: payment_intent.created]
INFO Got response from local endpoint, status=200

Note that responses from your server are not returned to Stripe and won’t show up in the Dashboard.

API requests

You can make API requests directly through the Stripe CLI. Run stripe resources to see the complete list of resources available and use --help or review the API Reference to get more information for each resource.

stripe payment_intents create --amount=100 --currency=usd

If you want to make requests for a specific API version, use the --stripe-version flag. See the changelog for the complete list of API versions.

stripe payment_intents create --amount=100 --currency=usd --stripe-version 2019-03-14

API versions

If you’re on an older version of the Stripe API, you can still test how webhook events behave on the latest API version without upgrading. To test webhook events on the latest API version, run the listen command with the --latest flag. Using this flag does not upgrade your account’s API version you can run it safely without any side effects.

stripe listen --forward-to localhost:5000/hooks --latest
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)

Supported events

Events triggered through the CLI are real objects in the Stripe API that you can interact with. These events can also trigger other webhook events (e.g., a payment_intent.succeeded event will also trigger a payment_intent.created event).

To see a list of supported events, visit the wiki. If you’d like to see support for an event that isn’t listed above, let us know.

More information

To see what else you can do with the Stripe CLI, use the stripe help command or check out the project on GitHub.

• Stripe CLI on GitHub
• List of all event types