Stripe CLI
The Stripe CLI is a developer tool to help you build, test, and manage your integration with Stripe directly from your terminal. The Stripe CLI is simple to install, works on macOS, Windows, and Linux, and offers 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.
Log in 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 log in to the Stripe Dashboard to grant the Stripe CLI access to your account.
stripe login
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.
Run your first command
You’re now ready to use the Stripe CLI. To get started run your first command to create a customer by running:
stripe customers create
This command creates a new customer on Stripe and returns the raw Customer object as JSON.