Skip to main content
GET
Get a customer

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Path Parameters

customerID
string<uuid>
required

Customer ID.

Response

The customer or the enrollment.

The customer and all their enrollments.

id
string<uuid>

Customer ID. Not the enrollment ID.

externalId
string

This customer's id in your own system.

name
string | null
email
string | null
taxId
string | null

CPF or CNPJ.

phone
string | null

Contact phone, in international format as digits only, without + (for example 5511999999999). Used for contact; it does not identify the customer.

pspRef
string | null

The customer's reference with the payment processor, when there is one.

createdAt
string<date-time>
enrollments
object[]