API Explorer

You are viewing an old version of the API

All Versions

Create customer

POST /v2/customers

Creates a new customer for a business.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Body

address

The physical address associated with the customer profile. For maximum length constraints, see Customer addresses. The first_name and last_name fields are ignored if they are present in the request.

Address

address_line_1

The first line of the address.

Fields that start with address_line provide the address's most specific details, like street number, street name, and building name. They do not provide less specific details like city, state/province, or country (these details are provided in other fields).

string

address_line_2

The second line of the address, if any.

string

address_line_3

The third line of the address, if any.

string

administrative_district_level_1

A civil entity within the address's country. In the US, this is the state. For a full list of field meanings by country, see Working with Addresses.

string

administrative_district_level_2

A civil entity within the address's administrative_district_level_1. In the US, this is the county.

string

administrative_district_level_3

A civil entity within the address's administrative_district_level_2, if any.

string

country

The address's country, in the two-letter format of ISO 3166. For example, US or FR.

string

Select country

US United States of America

first_name

Optional first name when it's representing recipient.

string

last_name

Optional last name when it's representing recipient.

string

locality

The city or town of the address. For a full list of field meanings by country, see Working with Addresses.

string

postal_code

The address's postal code. For a full list of field meanings by country, see Working with Addresses.

string

sublocality

A civil region within the address's locality, if any.

string

sublocality_2

A civil region within the address's sublocality, if any.

string

sublocality_3

A civil region within the address's sublocality_2, if any.

string

birthday

The birthday associated with the customer profile, in YYYY-MM-DD or MM-DD format. For example, specify 1998-09-21 for September 21, 1998, or 09-21 for September 21. Birthdays are returned in YYYY-MM-DD format, where YYYY is the specified birth year or 0000 if a birth year is not specified.

string

company_name

A business name associated with the customer profile.

The maximum length for this value is 500 characters.

string

email_address

The email address associated with the customer profile.

The maximum length for this value is 254 characters.

string

family_name

The family name (that is, the last name) associated with the customer profile.

The maximum length for this value is 300 characters.

string

given_name

The given name (that is, the first name) associated with the customer profile.

The maximum length for this value is 300 characters.

string

idempotency_key

The idempotency key for the request. For more information, see Idempotency.

string

nickname

A nickname for the customer profile.

The maximum length for this value is 100 characters.

string

note

A custom note associated with the customer profile.

string

phone_number

The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional + prefix and country code. For more information, see Customer phone numbers.

string

reference_id

An optional second ID used to associate the customer profile with an entity in another system.

The maximum length for this value is 100 characters.

string

tax_ids

The tax ID associated with the customer profile. This field is available only for customers of sellers in EU countries or the United Kingdom. In other countries, this field is ignored when included in a CreateCustomer request. For more information, see Customer tax IDs.

CustomerTaxIds

You are viewing an old version of the API

All Versions

Request

cURL

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums