POST
/
api
/
v1
/
customer
/
create
Customer Create Api
curl --request POST \
  --url https://api.justpaid.io/api/v1/customer/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "John Doe",
  "external_id": "CUST-001",
  "billing_address": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "shipping_address": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "currency": "USD",
  "contact_name": "<string>",
  "email": "<string>",
  "additional_emails": [
    "<any>"
  ],
  "billing_emails": [
    "<any>"
  ],
  "phone_number": "<string>",
  "tax_id": "<string>"
}'
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "external_id": "CUST-001",
  "billing_address": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "postal_code": "12345",
    "country": "US"
  },
  "shipping_address": {
    "street": "456 Elm St",
    "city": "Othertown",
    "state": "NY",
    "postal_code": "67890",
    "country": "US"
  }
}

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.

​
name
string
required

The name of the customer.

Example:

"John Doe"

​
external_id
string

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

Example:

"CUST-001"

​
billing_address
object | null

The customer's billing address. Schema for an address object.

Attributes: address_line1 (Optional[str]): The first line of the address. address_line2 (Optional[str]): The second line of the address. city (Optional[str]): The city of the address. state (Optional[str]): The state of the address. zip (Optional[str]): The ZIP code of the address. country (Optional[str]): The country of the address.

​
shipping_address
object | null

The customer's shipping address. Schema for an address object.

Attributes: address_line1 (Optional[str]): The first line of the address. address_line2 (Optional[str]): The second line of the address. city (Optional[str]): The city of the address. state (Optional[str]): The state of the address. zip (Optional[str]): The ZIP code of the address. country (Optional[str]): The country of the address.

​
currency
string | null
default:USD

The currency used by the customer.

Example:

"USD"

​
contact_name
string | null

The name of the contact person

Maximum length: 100
​
email
string | null
Maximum length: 50
​
additional_emails
any[] | null

A list of additional customer email addresses

​
billing_emails
any[] | null

Billing email addresses

​
phone_number
string | null

Customer phone number with country code

Maximum length: 20
​
tax_id
string | null

Customer tax id

Maximum length: 9

Response

Customer created successfully

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'.

​
uuid
string<uuid>

The unique identifier for the customer.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string

The name of the customer.

Example:

"John Doe"

​
contact_name
string | null

The name of the contact person for the customer.

Example:

"John Doe"

​
email
string | null

The primary email address of the customer.

Example:

"john.doe@example.com"

​
additional_emails
string[] | null

A list of additional email addresses for the customer.

Example:
[
  "john.doe@example.com",
  "jane.doe@example.com"
]
​
billing_emails
string[] | null

A list of email addresses used for billing purposes.

Example:
[
  "john.doe@example.com",
  "jane.doe@example.com"
]
​
phone_number
string | null

The customer's phone number, including country code.

Example:

"+1234567890"

​
currency
string | null

The currency used by the customer.

Example:

"USD"

​
tax_id
string | null

The customer's tax identification number.

Example:

"1234567890"

​
billing_address
object | null

The customer's billing address. Schema for an address object.

Attributes: address_line1 (Optional[str]): The first line of the address. address_line2 (Optional[str]): The second line of the address. city (Optional[str]): The city of the address. state (Optional[str]): The state of the address. zip (Optional[str]): The ZIP code of the address. country (Optional[str]): The country of the address.

​
shipping_address
object | null

The customer's shipping address. Schema for an address object.

Attributes: address_line1 (Optional[str]): The first line of the address. address_line2 (Optional[str]): The second line of the address. city (Optional[str]): The city of the address. state (Optional[str]): The state of the address. zip (Optional[str]): The ZIP code of the address. country (Optional[str]): The country of the address.

​
external_id
string | null

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

Example:

"CUST-001"