Skip to main content
POST
/
api
/
v1
/
customers
Create Customer
curl --request POST \
  --url https://api.example.com/api/v1/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "external_id": "<string>",
  "phone": "<string>",
  "billing_address_line1": "<string>",
  "billing_address_city": "<string>",
  "billing_address_state": "<string>",
  "billing_address_country": "<string>",
  "billing_address_postal_code": "<string>"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corp",
  "email": "billing@acme.com",
  "external_id": "acme-corp-001",
  "billing_address_country": "US",
  "billing_address_state": "CA",
  "created_at": "2025-01-01T00:00:00Z"
}
​
name
string
required
Customer display name
​
email
string
required
Billing contact email
​
external_id
string
Your own system’s customer ID (used in SDK tracking)
​
phone
string
Phone number
​
billing_address_line1
string
Street address
​
billing_address_city
string
City
​
billing_address_state
string
State/Province
​
billing_address_country
string
Country code (ISO 3166-1 alpha-2, e.g., “US”)
​
billing_address_postal_code
string
Postal/ZIP code
A billing address with at least billing_address_country is required to create invoices for this customer.
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corp",
  "email": "billing@acme.com",
  "external_id": "acme-corp-001",
  "billing_address_country": "US",
  "billing_address_state": "CA",
  "created_at": "2025-01-01T00:00:00Z"
}