GET
/v1/payment_intents/searchSearch PaymentIntents
Searches previously created PaymentIntents using the PaymentIntent search query language. Supply query to define the search, and use limit and page to control pagination; search results may lag behind recent changes and are unavailable to merchants in India.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
expandarray<string>optional
Specifies response fields to expand. Each expansion path can contain up to 5,000 characters.
limitintegeroptional
The number of PaymentIntents to return. Must be between 1 and 100, and defaults to 10 when omitted.
pagestringoptional
A cursor for retrieving the next page of results. Use the `next_page` value from a previous response and omit this parameter on the first request.
querystringrequired
The search query for PaymentIntents, using the supported PaymentIntent search query language. Maximum 5,000 characters.
200Returns a search result containing matching PaymentIntents in `data`, pagination fields including `has_more` and `next_page`, the total count up to 10,000, and the result URL.
dataarray<PaymentIntent>required
has_morebooleanrequired
next_pagestringoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
total_countintegeroptional
The total number of objects that match the query, only accurate up to 10,000.
urlstringrequired
defaultReturns an error object containing an `error` field with the error type and related details.
errorobjectrequired
Error handling
query is required and must be a search query string supported for PaymentIntents. limit must be an integer between 1 and 100, and page must be a pagination cursor returned by an earlier search; omit page on the first request.