---
title: "Retrieve a customer"
method: GET
path: "/v1/customers/{id}"
tags: ["Customers"]
---

# Retrieve a customer

`GET /v1/customers/{id}`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/customers/{id}`
- Auth: HTTP bearer

**Scope:** `read`

## Path parameters

- `id` string, required: Prefixed id (`cus_…`)

## Query parameters

- `expand[]` union: Relations to embed: partner, referral, link
  - string
  - string[]
- `include[]` union: Nothing to include on this resource
  - string
  - string[]

## Response `200`

The customer

- Customer
  - `id` string, required: Prefixed id (`cus_…`)
  - `object` 'customer', required
  - `program_id` string, required: Prefixed id (`prg_…`)
  - `partner_id` string, required: Prefixed id (`part_…`)
  - `referral_id` string, nullable, required: Prefixed id (`ref_…`)
  - `link_id` string, nullable, required: Prefixed id (`lnk_…`)
  - `coupon_id` string, nullable, required: Prefixed id (`cpn_…`)
  - `processor` 'stripe' | 'paddle' | 'chargebee' | 'manual' | 'api' | 'null', nullable, required
  - `external_customer_id` string, nullable, required
  - `external_subscription_id` string, nullable, required
  - `email` string, nullable, required
  - `name` string, nullable, required
  - `identifier` string, nullable, required
  - `status` 'lead' | 'trial' | 'active' | 'cancelled' | 'refunded' | 'suspended', required
  - `tracked_by` 'link' | 'coupon' | 'manual' | 'api', required
  - `lead_at` string, date-time, nullable, required: ISO-8601, UTC
  - `converted_at` string, date-time, nullable, required: ISO-8601, UTC
  - `metadata` object, nullable, required: Your own key/value data, stored as given
  - `created_at` string, date-time, required: ISO-8601, UTC
  - `updated_at` string, date-time, required: ISO-8601, UTC

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)