Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

A merchant secret key (sk_…) sent as Authorization: Bearer <key>.

Path Parameters

id
string
required

The customer id (cus_…).

Query Parameters

section_size
integer

Maximum items to return in payment_methods and recent_payments (1–100). Omit to return all.

Required range: 1 <= x <= 100

Response

The customer with full dashboard detail.

A customer enriched with payment summary data. The list endpoint returns summary, default_payment_method, and last_payment for each item. The retrieve endpoint additionally returns the full payment_methods and recent_payments arrays.

id
string
required

Unique customer identifier (cus_…).

object
enum<string>
required
Available options:
customer
merchant_id
string
required
livemode
boolean
required

Whether this customer was created with a live (true) or test (false) key.

email
string
required
first_name
string
required

Empty string when not set.

last_name
string
required

Empty string when not set.

phone
string
required

Empty string when not set.

billing_address
object | null
required

Billing address; null when not set.

shipping
object | null
required

Shipping details; null when not set.

creation_source
enum<string>
required

How the customer was created (for example api).

Available options:
api,
checkout,
import,
dashboard,
platform
payment_settings
object
required

Payment configuration stored for the customer.

metadata
object
required
deleted
boolean
required

True when the customer has been soft-deleted.

created_at
integer
required

Unix epoch seconds.

updated_at
integer
required
summary
object

Lifetime payment statistics for this customer.

default_payment_method
object

The customer's default payment method; absent when none is set.

last_payment
object

The customer's most recent payment; absent when there are none.

payment_methods
object[]

All payment methods on file. Only returned by the retrieve endpoint.

recent_payments
object[]

Recent payments. Only returned by the retrieve endpoint.