Skip to main content
GET
/
v1
/
charges
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/charges/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "b955cf2e-d276-4194-995f-dc037f98776b",
  "object": "charge",
  "amount": 2900,
  "currency": "usd",
  "disputed_amount": 0,
  "external_charge_id": "choyby9liq46uv1",
  "fully_refunded": false,
  "live_mode": true,
  "refunded_amount": 0,
  "customer": "4a2f3431-405b-4f2d-abc0-04b9a0d7392d",
  "checkout": "d211bc00-cb0e-4495-99d1-39d90ff72bf2",
  "payment_intent": "2af653c0-be45-4ce9-9b0c-ea55fb0fe593",
  "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.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
amount
integer

The amount in cents that was charged, represented as a whole integer. For example 9900 is equivalent to $99.

​
currency
string

Three-letter ISO currency code, in lowercase.

​
disputed_amount
integer

The amount in cents that has been disputed.

​
external_charge_id
string

The external processor ID representing this charge.

​
fully_refunded
boolean

Whether or not this charge has been refunded completely.

​
live_mode
boolean

Set to true if this charge is in live mode, and set to false if it is in test mode.

​
refunded_amount
integer

Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).

​
customer

Expandable – The associated customer ID.

​
checkout

Expandable – The associated checkout ID.

​
disputes

Expandable – Property not returned unless expanded.

​
payment_intent

Expandable – The associated payment intent ID.

​
payment_method

Expandable – The associated payment method ID.

​
refunds

Expandable – Property not returned unless expanded.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.