---
title: "Get customer by reference, externalRef, or email"
method: GET
path: "/v1/sdk/customers"
tags: ["Customers"]
---

# Get customer by reference, externalRef, or email

`GET /v1/sdk/customers`

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.

## Query parameters

- `reference` string
- `externalRef` string
- `email` string

## Response `200`

Customer retrieved successfully

- CustomerResponse
  - `email` string, required — Customer email address
  - `externalRef` string — External reference ID from your auth system (if set during creation or update)
  - `name` string, required — Customer full name
  - `purchases` PurchaseInfo[] — Active purchases
    - `amount` number, required — Amount in USD cents (normalised for aggregation)
    - `cancellationReason` string — Reason for cancellation
    - `cancelledAt` string — When purchase was cancelled
    - `currency` string, required — ISO 4217 currency code of the customer-facing charge
    - `endDate` string — End date of purchase
    - `exchangeRate` number — Exchange rate from original currency to USD
    - `originalAmount` number — Original amount in the payment currency (minor units)
    - `planRef` string — Plan reference from the plan snapshot, for reliable plan matching
    - `planSnapshot` object — Snapshot of the plan at time of purchase
    - `productName` string, required — Product name
    - `productRef` string — Product reference
    - `reference` string, required — Purchase reference
    - `startDate` string, required — Start date
    - `status` string, required — Purchase status
  - `reference` string, required — Customer reference identifier

## Other responses

- `400` — Invalid request - must provide exactly one of reference, externalRef, or email
- `404` — Customer not found

---

[API](https://skmtc.net/solvapay/apis/solvapay-rest-api.md) · [All operations](https://skmtc.net/solvapay/apis/solvapay-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/solvapay/solvapay-rest-api/revisions/bbc2ff2bc849/schema)