Get customer by reference

Retrieves a customer’s details using their unique reference ID. Returns the customer’s name, email, and active purchases. Only customers owned by the authenticated provider can be accessed.

GET /v1/sdk/customers/{reference}

Get customer by reference

cURL

curl --request GET \
  --url https://api.example.com/v1/sdk/customers/{reference}

200

{
  "email": "[e-mail]",
  "externalRef": "auth_user_12345",
  "name": "John Doe",
  "purchases": [
    {
      "amount": 9900,
      "currency": "USD",
      "endDate": "2025-11-27T10:00:00Z",
      "productName": "API Gateway Manager",
      "productRef": "prd_abc123",
      "reference": "pur_1A2B3C4D",
      "startDate": "2025-10-27T10:00:00Z",
      "status": "active"
    }
  ],
  "reference": "cus_3c4d5e6f7g8h"
}

Path Parameters

reference · string · required

Customer reference identifier

Example:

"cus_3c4d5e6f7g8h"

Response

200

application/json

Customer retrieved successfully

email · string · required

Customer email address

Example:

"[e-mail]"

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

Show child attributes