Customers
Get customer by reference, externalRef, or email
Retrieves a customer's details using their unique reference ID, externalRef, or email. Use query parameter 'reference' to look up by customer reference, 'externalRef' for external auth ID, or 'email' for customer email. Exactly one parameter must be provided. Returns the customer's name, email, and active purchases. Only customers owned by the authenticated provider can be accessed.
get/v1/sdk/customers
Query parameters
referencestring
Example:cus_3c4d5e6f7g8h
Customer reference identifier (use exactly one query parameter)
externalRefstring
Example:auth_user_12345
External reference ID from your auth system (use exactly one query parameter)
emailstring
Example:customer@example.com
Customer email address (use exactly one query parameter)
Response
Customer retrieved successfully
Example response
{
"email": "customer@example.com",
"externalRef": "auth_user_12345",
"name": "John Doe",
"purchases": [
{
"amount": 9900,
"cancellationReason": "Customer request",
"cancelledAt": "2025-10-28T10:00:00Z",
"currency": "GBP",
"endDate": "2025-11-27T10:00:00Z",
"exchangeRate": 1.32,
"originalAmount": 7500,
"planRef": "pln_abc123",
"productName": "API Gateway Manager",
"productRef": "prd_abc123",
"reference": "pur_1A2B3C4D",
"startDate": "2025-10-27T10:00:00Z",
"status": "active"
}
],
"reference": "cus_3c4d5e6f7g8h"
}