Create Customer

Important: Customer keys are immutable once created and cannot be changed through updates. Choose your customer key carefully during creation and ideally, should align with the unique id of the customer on your platform.

Authorizations

x-api-key

string

header

required

Body

application/json

customer_type

enum<string>

required

Type of customer

Available options:

BUSINESS,

INDIVIDUAL

customer_key

string

required

Unique identifier of the customer in your application

primary_email

string<email>

required

Primary email address for the customer

primary_phone

string

Primary phone number for the customer

legal_name

string

Legal business name

display_name

string

Display name for the business

legal_number

string

Legal registration number

tax_identification_number

string

Tax identification number

logo_url

string<uri>

URL to company logo

website_url

string<uri>

Company website URL

account_manager

string

Assigned account manager

first_name

string

First name

middle_name

string

Middle name

last_name

string

Last name

date_of_birth

string<date>

Date of birth (for individuals)

billing_email

string<email>

Email address for billing communications

timezone

string

Preferred timezone

language

string

Preferred language for communications

currency

string

Preferred currency for billing

tax_status

enum<string>

Tax status of the customer

Available options:

TAXABLE,

TAX_EXEMPT,

REVERSE_CHARGE

address_line1

string

First line of address

address_line2

string

Second line of address

city

string

City name

state

string

State or province

country

string

Country name

zip_code

string

ZIP or postal code

shipping_address_line1

string

First line of shipping address

shipping_address_line2

string

Second line of shipping address

shipping_city

string

Shipping city name

shipping_state

string

Shipping state or province

shipping_country

string

Shipping country name

shipping_zip_code

string

Shipping ZIP or postal code

billing_configuration

object

Show child attributes

billing_configuration.preferred_payment_gateway

string

Preferred payment gateway

billing_configuration.preferred_payment_method

string

Preferred payment method

billing_configuration.billing_email

string<email>

Email address for billing communications

billing_configuration.billing_address

string

Billing address

billing_configuration.payment_reminder_days

integer

Number of days before payment reminder

tax_identifications

object[]

Array of tax identification numbers

Show child attributes

tax_identifications.type

string

required

Type of tax identification (e.g., EIN, VAT, GST)

tax_identifications.number

string

required

Tax identification number

tax_identifications.country

string

required

Country where tax ID is registered

contact_people

object[]

List of contact persons for the business

Show child attributes

contact_people.first_name

string

required

First name of contact person

contact_people.last_name

string

required

Last name of contact person

contact_people.email_address

string<email>

required

Email address of contact person

contact_people.designation

string

Job title or designation

contact_people.department

string

Department name

contact_people.is_primary

boolean

default:false

Whether this is the primary contact person

contact_people.phone_number

string

Phone number for this contact person

payment_terms

object[]

Payment terms configuration

Show child attributes

payment_terms.type

string

required

Type of payment term (e.g., Net 30, Net 15)

payment_terms.value

string

required

Payment term value

metadata

object

Custom metadata

email_addresses

object[]

List of additional email addresses

Show child attributes

email_addresses.email

string<email>

required

Email address

email_addresses.is_primary

boolean

default:false

Whether this is the primary email address

phone_numbers

object[]

List of additional phone numbers

Show child attributes

phone_numbers.phone_number

string

required

Phone number

phone_numbers.country_code

string

required

Country code (e.g., +1, +44)

phone_numbers.is_primary

boolean

default:false

Whether this is the primary phone number

documents

object

Optional documents to attach to the customer

Response

Customer created successfully

message

string

Example:

"Customer Created"

data

object

Show child attributes

data.id

string<uuid>

Unique customer identifier in the Metrifox system

data.primary_email

string<email>

Primary email address

data.primary_phone

string

Primary phone number

data.legal_name

string

Legal business name

data.display_name

string

Display name for the business

data.legal_number

string

Legal registration number

data.tax_identification_number

string

Tax identification number

data.logo_url

string<uri>

URL to company logo

data.website_url

string<uri>

Company website URL

data.account_manager

string

Assigned account manager

data.first_name

string

First name

data.middle_name

string

Middle name

data.last_name

string

Last name

data.full_name

string

Full name

data.billing_email

string<email>

Email address for billing communications

data.timezone

string

Preferred timezone

data.language

string

Preferred language for communications

data.currency

string

Preferred currency for billing

data.tax_status

enum<string>

Tax status of the customer

Available options:

TAXABLE,

TAX_EXEMPT,

REVERSE_CHARGE

data.address_line1

string

First line of address

data.address_line2

string

Second line of address

data.city

string

City name

data.state

string

State or province

data.country

string

Country name

data.zip_code

string

ZIP or postal code

data.shipping_address_line1

string

First line of shipping address

data.shipping_address_line2

string

Second line of shipping address

data.shipping_city

string

Shipping city name

data.shipping_state

string

Shipping state or province

data.shipping_country

string

Shipping country name

data.shipping_zip_code

string

Shipping ZIP or postal code

data.created_at

string<date-time>

Creation timestamp

data.updated_at

string<date-time>

Last update timestamp

data.customer_type

enum<string>

Type of customer

Available options:

BUSINESS,

INDIVIDUAL

data.customer_key

string

Customer key if available

data.phone_numbers

object[]

List of phone numbers

data.email_addresses

object[]

List of email addresses

data.billing_configuration

object

Show child attributes

data.billing_configuration.preferred_payment_gateway

string

Preferred payment gateway

data.billing_configuration.preferred_payment_method

string

Preferred payment method

data.billing_configuration.billing_email

string<email>

Email address for billing communications

data.billing_configuration.billing_address

string

Billing address

data.billing_configuration.payment_reminder_days

integer

Number of days before payment reminder

data.tax_identifications

object[]

Array of tax identification numbers

Show child attributes

data.tax_identifications.type

string

required

Type of tax identification (e.g., EIN, VAT, GST)

data.tax_identifications.number

string

required

Tax identification number

data.tax_identifications.country

string

required

Country where tax ID is registered

data.contact_people

object[]

List of contact persons for the business

Show child attributes

data.contact_people.first_name

string

required

First name of contact person

data.contact_people.last_name

string

required

Last name of contact person

data.contact_people.email_address

string<email>

required

Email address of contact person

data.contact_people.designation

string

Job title or designation

data.contact_people.department

string

Department name

data.contact_people.is_primary

boolean

default:false

Whether this is the primary contact person

data.contact_people.phone_number

string

Phone number for this contact person

data.payment_terms

object[]

Payment terms configuration

Show child attributes

data.payment_terms.type

string

required

Type of payment term (e.g., Net 30, Net 15)

data.payment_terms.value

string

required

Payment term value

data.metadata

object

Custom metadata

data.date_of_birth

string<date>

Date of birth (for individuals)

data.documents

object

Attached documents

data.mid_cycle_invoice_consolidation

boolean

Whether to consolidate invoices mid-cycle

status

string

Example:

"created"

API Documentation

Customers

Usage

Finance

Checkout

Authorizations

Body

Response