Checkout Sessions
Customers
Payment Intents
Products
Plans
Purchases
curl --request GET \
--url https://api.example.com/v1/sdk/customers{
"email": "customer@example.com",
"externalRef": "auth_user_12345",
"name": "John Doe",
"purchases": [
{
"amount": 9900,
"currency": "USD",
"endDate": "2025-11-27T10:00:00Z",
"planName": "Pro Plan",
"productReference": "prd_abc123",
"reference": "sub_abc123",
"startDate": "2025-10-27T10:00:00Z",
"status": "active"
}
],
"reference": "cus_3c4d5e6f7g8h"
}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.
curl --request GET \
--url https://api.example.com/v1/sdk/customers{
"email": "customer@example.com",
"externalRef": "auth_user_12345",
"name": "John Doe",
"purchases": [
{
"amount": 9900,
"currency": "USD",
"endDate": "2025-11-27T10:00:00Z",
"planName": "Pro Plan",
"productReference": "prd_abc123",
"reference": "sub_abc123",
"startDate": "2025-10-27T10:00:00Z",
"status": "active"
}
],
"reference": "cus_3c4d5e6f7g8h"
}Query Parameters
Customer reference identifier (use exactly one query parameter)
"cus_3c4d5e6f7g8h"
External reference ID from your auth system (use exactly one query parameter)
"auth_user_12345"
Customer email address (use exactly one query parameter)
"customer@example.com"
Response
Customer retrieved successfully
Customer email address
"customer@example.com"
Customer full name
"John Doe"
Customer reference identifier
"cus_3c4d5e6f7g8h"
External reference ID from your auth system (if set during creation or update)
"auth_user_12345"
Active purchases
Show child attributes
Show child attributes