Use cases

Workbench provides many tools for developers to debug, manage, and grow their Stripe integration. These guides help you understand how to accomplish common developer tasks.

View the API versions used by API requests

When you send requests to Stripe, you can specify an API version with the Stripe-Version header. If you don’t specify an API version, Stripe uses your account’s default API version.

1. Open the Overview tab in Workbench.
2. Review the API versions section to see requests made in the last week.
3. Your account’s default API version shows the label Default. Any requests made using the latest API version show the label Latest.

To view a list of versions, see the API changelog

View recent integration errors

Stripe automatically groups recent integration errors by error type and endpoint.

1. Open the Errors tab in Workbench.
2. In the Recent errors pane, select the time period to filter errors by.
3. Click a group of errors to see the Summary describing the number of occurrences, API endpoint, and request source.

View API request logs by HTTP method or status

Use these steps to filter API request logs by HTTP method or status.

1. Open the Logs tab in Workbench.
2. Click Status to filter by Succeeded or Failed requests. (See the complete list of HTTP status codes that Stripe returns.)
3. Click Apply.

View API request logs by source

Use these steps to filter API request logs by source. API requests can originate by either actions in the Dashboard, or by a direct API call (for example, by using an SDK).

1. Open the Logs tab in Workbench.
2. Click More filters.
3. In Source, select Dashboard or API to filter requests by source.
4. Click Apply.

Filter by resource ID

When you create, update, or delete a Stripe resource using Stripe APIs, Stripe returns a resource ID in the response payload. For example, when you Create a customer, Stripe returns a customer ID (in the id field), such as cus_ImZZa3EEvvQQQU. Use these steps to filter API requests by resource ID.

1. Open the Logs tab in Workbench.
2. Enter the resource ID in the Filter by resource ID text field and press Enter on your keyboard.

Filter events

Use these steps to view events and their event object payload.

1. Open the Events tab in Workbench.
2. To filter by event, click Event type:
   • Enter an event name. For example, payment_intent.created.
   • Enter an event with the wildcard character. For example, payment_intent.*.
3. Click Apply.

View errors for a workflow run

You can use Workbench to inspect a workflow run. Click a step in the workflow in the Dashboard to see details, or open it in Workbench for inspection. To learn more, see Set up a workflow.