Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources
Overview
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Essentials
SDKs
API
Testing
Stripe CLI
Sample projects
Tools
Workbench
Developers Dashboard
Stripe Shell
    Overview
    Get started
    Keyboard shortcuts
Stripe for Visual Studio Code
Features
Workflows
Event destinations
Stripe health alertsFile uploads
AI solutions
Agent toolkit
Model Context Protocol
Security and privacy
Security
Privacy
Extend Stripe
Build Stripe apps
Use apps from Stripe
Partners
Partner ecosystem
Partner certification
HomeDeveloper resourcesStripe Shell

Get started with the Stripe Shell

Get started with the Stripe Shell on any page in the Stripe docs site.

This page describes how to launch the Stripe Shell terminal window from any page on the Stripe docs site and how to get started.

Initial setup

  1. To begin, you need a Stripe account. If you don’t already have one, follow these instructions.
  2. Click Sign in to authenticate with your Stripe account’s test API secret key.

Listen for events

  1. Press the Control + Backtick (on Windows, Linux or macOS) keys on your keyboard to launch the Stripe Shell.
  2. Click the stripe listen command to listen for events, or type the command and press the Enter key on your keyboard.
Command Line
stripe listen

This launches a Stripe Shell session inside a new frame at the bottom of the site and displays a command-line terminal.

Run your first request

  1. Press the Alt + Shift + D (on Windows, Linux) or Command + D (on macOS) keys on your keyboard to open a new pane.
  2. Click the green play button to run the command, or copy and paste the command and press the Enter key on your keyboard.
  3. Copy the Stripe resource identifier (in id) in the response for subsequent requests.
Command Line
stripe products create \ --name="Introductory offer (Monthly)" \ --description="$0.99 per month"

This creates a product with a name and description.

Get started with a video

Watch this video to learn all of the different ways to use the Stripe Shell.

Loading video content...

Next steps

  • Keyboard shortcuts in the Stripe Shell
Was this page helpful?
YesNo
  • Need help? Contact Support.
  • Join our early access program.
  • Check out our changelog.
  • Questions? Contact Sales.
  • LLM? Read llms.txt.
  • Powered by Markdoc