Stripe CLI

The Stripe CLI is a developer tool to help you help build, test, and manage your integration with Stripe directly from your terminal. The Stripe CLI is easy to install, works on macOS, Windows, and Linux, and offers you a range of functionality to make your developer experience with Stripe better.

With the Stripe CLI, you can:

• Securely test webhooks without relying on third-party tunneling software
• Trigger webhook events to easily test your integration
• Receive API request logs locally
• 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
brew install stripe/stripe-cli/stripe

sudo apt-key adv --keyserver hkp://pool.sks-keyservers.net:80 --recv-keys 379CE192D401AB61
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
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 update

sudo apt-get install stripe
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/
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 install stripe
sudo yum install stripe

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

scoop install stripe
scoop install stripe

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

Step 2: Login with your Stripe account

After installing the Stripe CLI, you must pair it with your Stripe account. To do so, run stripe login in the terminal. You’ll be prompted to launch your browser and login to the Stripe Dashboard to grant the Stripe CLI access to your account.

stripe login
stripe login

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

Pairing generates a pair of secret API keys—one test mode, one live mode—that are valid for 90 days. You can also manually delete the key under API Keys in the Dashboard (e.g., when you’re done using the Stripe CLI). If you’re in an environment that doesn’t have a browser, a URL will be printed to use outside of that environment.

Step 3: Run your first command

You are now ready to use the Stripe CLI, and to get started you can run your first command to create a customer by running:

stripe customers create
stripe customers create

This command creates a new customer on Stripe and returns the raw Customer object as JSON.

Next steps

To see what else you can do with the Stripe CLI, use the following guides or run the stripe --help command to see what’s possible.

• Listen to webhooks events
• Test and monitor your integration
• Configure the Stripe CLI
• Stripe CLI Reference