POST
/
api
/
v1
/
customer
/
create

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema for creating or updating a customer.

Attributes: name (str): The name of the customer. contact_name (Optional[str]): The name of the contact person for the customer. email (Optional[str]): The primary email address of the customer. additional_emails (Optional[List[str]]): A list of additional email addresses for the customer. billing_emails (Optional[List[str]]): A list of email addresses used for billing purposes. phone_number (Optional[str]): The customer's phone number, including country code. currency (Optional[str]): The currency used by the customer, defaulting to USD. tax_id (Optional[str]): The customer's tax identification number. billing_address (Optional[AddressSchema]): The customer's billing address. shipping_address (Optional[AddressSchema]): The customer's shipping address. external_id (Optional[str]): An external identifier for the customer.

additional_emails
any[] | null

A list of additional customer email addresses

billing_address
object | null

The customer's billing address.

billing_emails
any[] | null

Billing email addresses

contact_name
string | null

The name of the contact person

Maximum length: 100
currency
string | null
Maximum length: 3
email
string | null
Maximum length: 50
external_id
string

An optional external identifier for the customer. This can be used to link the customer to an external system.

name
string | null

Customer name

Maximum length: 100
phone_number
string | null

Customer phone number with country code

Maximum length: 20
shipping_address
object | null

The customer's shipping address.

tax_id
string | null

Customer tax id

Maximum length: 9

Response

200 - application/json

Schema for retrieving customer information.

Attributes: uuid (UUID): The unique identifier for the customer. name (str): The name of the customer. contact_name (Optional[str]): The name of the contact person for the customer. email (Optional[str]): The primary email address of the customer. additional_emails (Optional[List[str]]): A list of additional email addresses for the customer. billing_emails (Optional[List[str]]): A list of email addresses used for billing purposes. phone_number (Optional[str]): The customer's phone number, including country code. currency (Optional[str]): The currency used by the customer. tax_id (Optional[str]): The customer's tax identification number. billing_address (Optional[AddressSchema]): The customer's billing address. shipping_address (Optional[AddressSchema]): The customer's shipping address. external_id (Optional[str]): An external identifier for the customer, aliased as 'external_customer_id'.

additional_emails
string[] | null

A list of additional email addresses for the customer.

billing_address
object | null

The customer's billing address.

billing_emails
string[] | null

A list of email addresses used for billing purposes.

contact_name
string | null

The name of the contact person for the customer.

currency
string | null

The currency used by the customer.

email
string | null

The primary email address of the customer.

external_id
string | null

An optional external identifier for the customer. This can be used to link the customer to an external system.

name
string

The name of the customer.

phone_number
string | null

The customer's phone number, including country code.

shipping_address
object | null

The customer's shipping address.

tax_id
string | null

The customer's tax identification number.

uuid
string

The unique identifier for the customer.