Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Refunds

List Refunds

Returns a list of your refunds, most recent first.

get/v1/refunds

Query parameters

status'pending' | 'requires_action' | 'succeeded' | 'failed' | 'canceled'

The current status of the refund.

Example:pending

Filter by refund status.

payment_intentstring nullable

Filter by payment intent ID.

Example:fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by payment intent ID.

checkout_sessionstring nullable

Filter by checkout session ID.

Example:fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by checkout session ID.

starting_afterstring nullable

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

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.

ending_beforestring nullable

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

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.

limitinteger nullable

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

Example:10

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

Response

An envelope wrapping a list of refund objects.

Example response

{
  "refunds": [
    {
      "refund_id": "fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "amount": 2500,
      "created_at": "2026-06-15T14:30:00Z",
      "status": "pending",
      "test_mode": false,
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "items": [],
      "subscription_id": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "invoice_id": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
    }
  ]
}