Skip to main content
POST
Typescript (SDK)
Search API requests and incoming Stripe webhooks for your organization and environment.

Common Use Cases

Writing a query

Use where to filter, order by to sort, and limit to cap results. Join these steps with |. Without a query, you get the most recent logs. Filter on fields like customer_id, status_code, request_path, and stripe_event_type. Use dot paths for body fields, such as request_body.feature_id, or contains to find text: where response_body contains 'error'. Field names inside the query stay in snake_case, including when you use the TypeScript SDK. By default, the search covers the last 30 minutes. Set range to search another window of up to 365 days.

Body Parameters

Response

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string
default:2.6.0
required

Body

application/json
query
string

Filter and sort logs using where, order by, and limit, joined with |. Omit to return recent logs.

Maximum string length: 4000
range
SearchLogsRange · object

Time window to search. Defaults to the last 30 minutes. Maximum 365 days.

limit
integer

Maximum number of logs to return, from 1 to 200. Defaults to 100.

Required range: 1 <= x <= 200

Response

200 - application/json

OK

list
object[]
required

Matching logs, newest first unless you specify an order.