Skip to main content
POST
Create Customer

Body

first_name
string | null
default:John

Customers first name.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
last_name
string | null
default:Doe

Customers last name.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
company
string | null
default:US Oil Supply

Company associated with the customer.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
merchant_identifier
string | null
default:EID-987654-321

Merchants customer identifier. This field can be used as a reference back to your internal data system.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
phone_number
string | null
default:555-555-555

Customers phone number. This could be a cellular, land line, or a fax number.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
email_address
string | null
default:email@email.com

Customers email address.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
shipping_address
object
metadata
object | null

Metadata associated with the customer. This is a key value pair.

initiated_by_user_id
integer<int64> | null

Response

OK

customer
object
request_id
string
default:000000000000000000000
Required string length: 1 - 100
errors
object[] | null