Skip to main content
POST
Create customer

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <live_api_key>.

Headers

Idempotency-Key
string

Optional key for POST /customer/create, POST /invoice/create-quote, POST /invoice/create-invoice, POST /invoice/update-invoice, and POST /order/add-order. Reusing the same key with the same request replays a successful response for 24 hours; reusing it with a different request returns 409.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9._-]{1,100}$

Body

name
string
required
address_1
string
required
city
string
required
county_id
integer
required
country_id
integer
required
postal_code
string
required
phone
string
required
username
string<email>
required
password
string<password>
required
address_2
string
fax
string
email_verified
boolean
default:false

When true, marks the customer email as verified and suppresses the verification email. Use this when the integrating platform has already verified the address.

website
string<uri>
credit
number
business_name
string
comment
string

Response

Created

success
boolean