Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Developer tools
Get started
Payments
Finance automation
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Overview
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Developer tools
SDKs
API
Testing
Workbench
    Overview
    Use cases
    Manage event destinations
    Health alerts and insights
    Shell and API Explorer
    Keyboard shortcuts
Event Destinations
Workflows
Stripe CLI
Stripe Shell
Developers Dashboard
Agent toolkit
Stripe health alertsBuilding with LLMsStripe for Visual Studio CodeFile uploads
Security
Security
Extend Stripe
Stripe Apps
Stripe Connectors
Partners
Partner ecosystem
Partner certification
HomeDeveloper toolsWorkbench

Shell and API Explorer

Use a command line interface to manage your integration and explore APIs.

Copy page

Shell is a command line interface within Workbench that provides many of the same commands built into the Stripe CLI. When using Workbench, a minimal Shell is always available at the bottom of the pane, or use the Shell tab to launch a full-screen session.

Use the following Shell features to help you manage and debug your Stripe integration:

  • Autocompletion: Shell provides tab completion for API requests and CLI commands.
  • API Explorer: Use the built-in API Explorer to visually explore API resources and build API calls from Shell.

Note

Shell runs in the browser, so it has some limitations when compared to the Stripe CLI, which can receive and trigger webhook events on your local machine with a local event listener. See Test a webhooks integration with the Stripe CLI to learn more.

Initial setup

Sign in to the Dashboard. From the Developers menu, click Workbench. Switch to the Shell tab.

Common mistake

Shell is read-only in live mode. Switch to a sandbox to run API requests that create, modify, or delete API objects.

Listen for events

  1. From the command line prompt, type stripe listen to listen for webhook events, then press Enter on your keyboard to run the command.
Command Line
stripe listen

This listens to incoming events for your Stripe account.

Run your first API request

  1. Click New pane to open a new session in a pane alongside your existing session.
  2. Copy the command, paste it into the command line prompt, then press Enter on your keyboard.
  3. Copy the object identifier (in id) from 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.

Use the API Explorer

  1. Click API Explorer to show the interactive API Explorer on the right.
  2. Choose the Products resource and the Update method. The API Explorer shows all the required and optional parameters for the Products resource.
  3. Paste the object identifier from the previous step into the Value for the id path argument. When you provide the API Explorer with an existing object’s identifier, it loads the properties of the existing product.
  4. Update the optional parameter description to 1.99 USD per month. The API Explorer automatically populates Shell with the equivalent API command to update the product’s description. Press Enter to run the command and update the product.
  5. Click Print SDK code to see the equivalent code snippet in the language of your choice.

Available commands

Shell provides multiple commands in addition to the stripe command (see the Stripe CLI reference).

CommandPurpose
cdNavigates to other documentation pages
clearClears all prior text from the shell
lsLists Dashboard pages relative to the current one
pwdPrints the current page slug and title
shortcutsDisplays keyboard shortcuts that you can use with Shell
stripeAvailable Stripe CLI commands (see the complete reference)
whoamiDisplays logged in merchant details
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