Skip to main content
GET
/
v1
/
charges
List
curl --request GET \
  --url https://{defaultHost}/v1/charges \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/charges"
  },
  "data": [
    {
      "id": "61cb7da5-cada-437c-bf3a-d8cb0af2c4dc",
      "object": "charge",
      "amount": 2900,
      "currency": "usd",
      "disputed_amount": 0,
      "external_charge_id": "31r0nlg3uwdxxkh",
      "fully_refunded": false,
      "live_mode": true,
      "refunded_amount": 0,
      "customer": "bdfaf083-a461-408e-b880-64a6b92a96ce",
      "checkout": "90ea02fa-c47a-4a3e-9f3d-4d541d7127a4",
      "payment_intent": "a376b608-ef6f-4b3d-8386-9ff37f97fbab",
      "payment_method": null,
      "created_at": 1773903531,
      "updated_at": 1773903531
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

checkout_ids[]
string[]

Only return objects that belong to the given checkouts.

customer_ids[]
string[]

Only return objects that belong to the given customers.

external_charge_ids[]
string[]

Only return objects with the given external charge IDs.

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

live_mode
boolean

Only return objects that are live mode or test mode.

page
integer

The page of items you want returned.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.