Skip to content

Create customer

POST
/v1/customers/

Create a new customer.

CustomerCreate
object
external_id
required
External Id
string
>= 1 characters <= 255 characters
name
required
Name
string
>= 1 characters <= 255 characters
email
Any of:
string format: email
currency
Currency
string
default: USD >= 3 characters <= 3 characters
timezone
Timezone
string
default: UTC <= 50 characters
billing_metadata
Billing Metadata
object
key
additional properties
any
invoice_grace_period
Invoice Grace Period
integer
0
net_payment_term
Net Payment Term
integer
default: 30

Successful Response

CustomerResponse
object
id
required
Id
string format: uuid
external_id
required
External Id
string
name
required
Name
string
email
required
Any of:
string
currency
required
Currency
string
timezone
required
Timezone
string
billing_metadata
required
Billing Metadata
object
key
additional properties
any
invoice_grace_period
required
Invoice Grace Period
integer
net_payment_term
required
Net Payment Term
integer
billing_entity_id
Any of:
string format: uuid
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized – invalid or missing API key

Customer with this external_id already exists

Validation error