GET
/v1/credit_notesList all credit notes
Lists credit notes that match the supplied filters. Filter by creation interval, customer, customer account, or invoice, and use starting_after or ending_before to paginate the results.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
createdobjectoptional
Filter credit notes by creation time using a Unix timestamp or a range query with `gt`, `gte`, `lt`, or `lte`.
customerstringoptional
Return only credit notes associated with this customer identifier.
customer_accountstringoptional
Return only credit notes associated with the account representing the customer.
ending_beforestringoptional
Pagination cursor identifying the object before which to return results.
expandarray<string>optional
Fields to expand in the response; each value must be no more than 5000 characters.
invoicestringoptional
Return only credit notes associated with this invoice identifier.
limitintegeroptional
Maximum number of credit notes to return. Must be between 1 and 100; defaults to 10 when omitted.
starting_afterstringoptional
Pagination cursor identifying the object after which to return results.
200Returns a paginated list object containing credit notes in `data`, a `has_more` indicator, the list object type, and the collection URL.
dataarray<CreditNote>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.
defaultReturned when the API reports an error and includes an `error` object describing the failure.
errorobjectrequired
Error handling
limit must be an integer from 1 through 100, and created must be either a Unix timestamp or a range query with supported comparison fields. Use valid identifiers for customer, customer_account, invoice, starting_after, and ending_before when supplying those filters or cursors.