Skip to main content
GET
List Refunds

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

status
enum<string> | null

Filter by refund status.

Available options:
pending,
requires_action,
succeeded,
failed,
canceled
Example:

"pending"

payment_intent
string | null

Filter by payment intent ID.

Example:

"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

checkout_session
string | null

Filter by checkout session ID.

Example:

"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

starting_after
string | null

A cursor for use in pagination. starting_after is a refund ID that defines your place in the list. For instance, if you make a list request and receive 20 refunds, ending with fre_xyz, your subsequent call can include starting_after=fre_xyz to fetch the next page.

Example:

"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

A cursor for use in pagination. ending_before is a refund ID that defines your place in the list. For instance, if you make a list request and receive 20 refunds, starting with fre_abc, your subsequent call can include ending_before=fre_abc to fetch the previous page.

Example:

"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

limit
integer<int32> | null

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Required range: 1 <= x <= 100
Example:

10

Response

An envelope wrapping a list of refund objects.

An envelope wrapping a list of refund objects.

refunds
object[]
required

The list of refund objects.