Skip to main content
GET
List refunds

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Query Parameters

limit
integer
default:50

Number of refunds to return. Min 1, max 100. Default 50.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of refunds to skip before returning results. Default 0.

Required range: x >= 0
status
enum<string>

Return only refunds in this state. processing: the refund is on its way to the customer. success: the customer has been refunded. failed: the refund did not complete and the money stayed put.

Available options:
processing,
success,
failed

Response

Success - Refunds listed

total
integer

Total number of refunds matching the query, across all pages.

Example:

42

items
object[]

Refund objects for the current page.