Skip to main content
GET
/
v1
/
refunds
List Refunds
curl --request GET \
  --url https://api.withflex.com/v1/refunds \
  --header 'Authorization: Bearer <token>'
{
  "refunds": [
    {
      "refund_id": "obj_01EXAMPLE00000000000000000",
      "payment_intent_id": "obj_01EXAMPLE00000000000000000",
      "amount": 0,
      "created_at": "2024-01-01T00:00:00Z",
      "reason": "duplicate",
      "status": "pending",
      "test_mode": false,
      "metadata": {},
      "reference_id": "obj_01EXAMPLE00000000000000000",
      "reference_type": "acquirer_reference_number",
      "reference_status": "available",
      "items": [],
      "subscription_id": "obj_01EXAMPLE00000000000000000",
      "invoice_id": "obj_01EXAMPLE00000000000000000"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.withflex.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
status
enum<string> | null

Filter by refund status (e.g., pending, succeeded, failed).

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

"pending"

​
payment_intent
string | null

Filter by payment intent ID.

Example:

"obj_01EXAMPLE00000000000000000"

​
checkout_session
string | null

Filter by checkout session ID.

Example:

"obj_01EXAMPLE00000000000000000"

​
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:

"obj_01EXAMPLE00000000000000000"

​
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:

"obj_01EXAMPLE00000000000000000"

​
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

Success

​
refunds
object[]
required