Skip to main content
GET
Get customer by reference

Authorizations

Authorization
string
header
required

Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.

Path Parameters

reference
string
required

Customer reference identifier

Example:

"cus_3c4d5e6f7g8h"

Response

Customer retrieved successfully

email
string
required

Customer email address

Example:

"customer@example.com"

name
string
required

Customer full name

Example:

"John Doe"

reference
string
required

Customer reference identifier

Example:

"cus_3c4d5e6f7g8h"

externalRef
string

External reference ID from your auth system (if set during creation or update)

Example:

"auth_user_12345"

purchases
object[]

Active purchases