Search

Some top-level API resource have support for retrieval via “search” API methods. For example, you can search charges, search customers, and search subscriptions.

Stripe’s search API methods utilize cursor-based pagination via the page request parameter and next_page response parameter. For example, if you make a search request and receive "next_page": "pagination_key" in the response, your subsequent call can include page=pagination_key to fetch the next page of results.

Our client libraries offer auto-pagination helpers to easily traverse all pages of a search result.

Search request format

• query required The search query string. See search query language.
• limit optional A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
• page optional A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Search response format

• object string, value is "search_result" A string describing the object type returned.
• url string The URL for accessing this list.
• has _ more boolean Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
• data array An array containing the actual response elements, paginated by any request parameters.
• next _ page string A cursor for use in pagination. If has_more is true, you can pass the value of next_page to a subsequent call to fetch the next page of results.
• total _ count optional positive integer or zero The total number of objects that match the query, only accurate up to 10,000. This field isn’t included by default. To include it in the response, expand the total_count field.

Was this section helpful? Yes No

Response

Auto-pagination

Our libraries support auto-pagination. This feature allows you to easily iterate through large lists of resources without having to manually perform the requests to fetch subsequent pages.

Since curl simply emits raw HTTP requests, it doesn’t support auto-pagination.

Was this section helpful? Yes No

# The auto-pagination feature is specific to Stripe's# libraries and cannot be used directly with curl.

Request IDs

Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard.

To expedite the resolution process, provide the request identifier when you contact us about a specific request.

Was this section helpful? Yes No