List Refunds
Intent
Reads the available refunds as a pageable collection without changing them.
When to call it
Call this when an interface, sync, or support workflow needs to inspect refunds. Use the filters and paging controls shown below to limit the result.
Access boundary
Authorize the request with a token that carries refunds:read or refunds:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Query Parameters
Return only records matching refund ID. Identifier of the refund.
Return only records matching organization ID. Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Return only records matching order ID. Identifier of the order.
Return only records matching subscription ID. Identifier of the subscription.
Return only records matching customer ID. Identifier of the customer.
Return only records matching customer external ID. Identifier of the customer external.
Return only records matching succeeded.
Results page to return. The first page is used by default.
Records returned per page. Defaults to 10 and accepts up to 100.
Sort rules applied from left to right. Prefix any rule with - to reverse it into descending order.
created_at, -created_at, amount, -amount