The Customer object
The shape of a customer wherever the API returns one.
Every endpoint that returns a customer returns this shape, wrapped in a data envelope.
Attributes
id
uuid · always present—
reference
string · optional—
type
enum · always present— One of: individual, business.
first_name
string · always present—
last_name
string · always present—
email
string · optional—
phone
string · optional—
country
string · optional—
tags
array of string · optional—
archived
boolean · always present—
created_at
timestamp · always present—
totals
object · optionalOnly on Fetch a customer.
{
"id": "0d6c2f3a-1b4e-4c9a-9f2d-7a1e5c8b3d60",
"reference": "<reference>",
"type": "individual",
"first_name": "<first_name>",
"last_name": "<last_name>",
"email": "<email>",
"phone": "<phone>",
"country": "<country>",
"tags": [],
"archived": "<archived>",
"created_at": "2026-09-01T10:04:11Z",
"totals": "<totals>"
}Customers
The people and businesses you are paid by and pay out to.
Create a customer
Returns 201 for a new customer, and 200 if this `reference` already names one with the same details. Different details return 409 `reference_conflict`; use Update a customer to change them. Needs the `receive` capability.