Skip to main content

​
Customers

​
In a nutshell

Customers are the end users or businesses you bill through subscriptions. A customer can have subscriptions, saved payment sources, and payment history.

​
Customer fields

FieldDescription
codePublic customer code, such as CUST_9XyZ456q.
emailRequired customer email.
nameOptional customer name.
phoneNumberOptional phone number.
externalRefOptional ID from your own system.

​
Create a customer

curl -X POST https://api.example.com/v1/customer/ \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: sub_xxx" \
  -d '{
    "email": "customer@example.com",
    "name": "Ada Lovelace",
    "externalRef": "user_123"
  }'

​
Lookup

Retrieve a customer by email or customer code: 
GET /v1/customer/:emailOrCode

​
API

See Customers API Reference.