Create a Customer

post

https://sandbox-api.prioritycommerce.com/v1/checkout/v3/customer

Create a new customer profile with contact information, billing details, and optional custom fields for the authenticated merchant.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

echo

boolean

Defaults to true

If true, the API will echo the full payment resource in the response body

Body Params

The Customer information.

Customer model

name

string

Customer's full name (display name)

firstName

string

Customer's first name

lastName

string

Customer's last name

number

string

Client provided customer number

taxId

string

length ≤ 9

Customer's SSN or EIN (9 digits) (Required for tax exempt customers)

string

Customer's email address

mobile

string

Customer's cellphone number

phone

string

Customer's home phone number (if any)

spendProfile

string

Customer's spend profile

customFields

array of objects

Array of custom fields

customFields

addressName

string

(headquarters, administrative)

address1

string

Street address

address2

string

Apartment, suite, department

city

string

City

state

string

State

zip

string

^\d{5}(?:[-]\d{4})?$|^\d{9}$|(^[ABCEGHJKLMNPRSTVXYabceghjklmnprstvxy]{1}\d{1}[A-Za-z]{1} *\d{1}[A-Za-z]{1}\d{1}$)

Zip

customerType

string

enum

customer type

Allowed:

spendProfileOverride

boolean

If the spend profile was selected or sent manually, this would be true.

isTaxExempt

boolean

Indicates whether the customer is exempt from paying the tax

merchantId

int32

Merchant ID

activeStatus

boolean

Indicates whether the customer is active or inactive

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The entity has been created successfully.

400The request could not be accepted by the MXM server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

401The request could not be authenticated. The API key or access token may be missing, invalid, or expired.

403The authenticated user does not have permission to perform this action on the requested resource.

422The MXM server understood the request but was unable to process it due to semantic errors or invalid field values in the request body.

500An unexpected error occurred on the MXM server. If the issue persists, please contact support.

503The MXM server is temporarily unable to handle the request. Please retry after a short delay.