Sign in

34b7cf5b4b6c

latestOpenAPI 3.1.02026-08-122324681.8 MB
Customers

Create customer

Create a new customer record with address information.

Set is_taxable to false to create a tax-exempt customer (for example resellers, government agencies, or qualifying non-profits). Omit the field to use the default (false).

post/public/v2/customers/

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

custom_fieldsobject[] nullable
namestring required
unique_idstring nullable
emailstring required
addressstring required
countrystring required
phonestring required
websitestring required
is_taxableboolean

Whether tax is calculated for this customer. Set to false to mark the customer as tax-exempt.

Response

Created

approval_statusstring nullable
idinteger required
addressstring required
countrystring required
namestring required
unique_idstring nullable required
websitestring required
emailstring required
customer_typestring required
is_activeboolean required
phonestring required
record_statusstring required
is_taxableboolean required
default_tax_codestring required
tax_registration_numberstring required