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": "84826e20-b9d4-40c4-bb10-6f8ab288279d",
      "object": "charge",
      "amount": 2900,
      "currency": "usd",
      "disputed_amount": 0,
      "external_charge_id": "2owlef9mv8enxab",
      "fully_refunded": false,
      "live_mode": true,
      "refunded_amount": 0,
      "customer": "dd184ee2-8788-419e-b9c3-5d1b49845d51",
      "checkout": "1efd6625-e568-4337-aba3-0a45f5d2e85f",
      "payment_intent": "bae6b3bc-56c5-4a85-a575-a4dcdab60425",
      "payment_method": null,
      "created_at": 1771429852,
      "updated_at": 1771429852
    }
  ]
}

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.