GET
/v1/refundsList all refunds
Lists refunds created through the API, with the most recent refunds first. Use charge or payment_intent to filter the results, and use cursor parameters to retrieve adjacent pages.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
chargestringoptional
Only return refunds associated with the specified charge ID.
createdobjectoptional
Only return refunds created at the specified Unix timestamp or within the specified date interval.
ending_beforestringoptional
Cursor based on an object ID; returns the previous page of refunds before that object.
expandarray<string>optional
Fields to expand in each response object.
limitintegeroptional
Maximum number of refunds to return, from 1 to 100. Defaults to 10 when omitted.
payment_intentstringoptional
Only return refunds associated with the specified PaymentIntent ID.
starting_afterstringoptional
Cursor based on an object ID; returns the next page of refunds after that object.
200Returns a list containing refund objects in reverse chronological order, a `has_more` indicator, the `list` object type, and the list URL.
dataarray<Refund>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
limit must be between 1 and 100 and defaults to 10 when omitted. Use starting_after or ending_before with an object ID to move through the list, and provide created as a timestamp or date-range query when filtering by creation time.