GET
/v1/invoices/searchSearch invoices
Searches invoices using the supplied search query. Use query with the invoice search query language, and use page and limit to paginate results; search data can lag behind recent changes and is unavailable to merchants in India.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
expandarray<string>optional
Specifies response fields to expand; each expansion name can contain up to 5,000 characters.
limitintegeroptional
Maximum number of invoices to return. Must be between 1 and 100, and defaults to 10 when omitted.
pagestringoptional
Pagination cursor from a previous response's `next_page` value. Omit it on the first request.
querystringrequired
Search query expressed in the invoice search query language. Maximum 5,000 characters.
200Returns a search result containing matching invoice objects in `data`, pagination fields including `has_more` and `next_page`, the total match count up to 10,000, and the result URL.
dataarray<Invoice>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
defaultError response.
errorobjectrequired
Error handling
query is required and must be a search query string of no more than 5,000 characters. limit accepts values from 1 to 100, and page must contain a pagination cursor returned by a previous search; omit page on the first request.