Create customer
Creates a new customer for a business.
You must provide at least one of the following values in your request to this endpoint:
given_name
family_name
company_name
email_address
phone_number
Name | Description |
---|---|
idempotency_
|
The idempotency key for the request. For more information, see Idempotency. |
given_
|
The given name (that is, the first name) associated with the customer profile. The maximum length for this value is 300 characters. |
family_
|
The family name (that is, the last name) associated with the customer profile. The maximum length for this value is 300 characters. |
company_
|
A business name associated with the customer profile. The maximum length for this value is 500 characters. |
nickname
|
A nickname for the customer profile. The maximum length for this value is 100 characters. |
email_
|
The email address associated with the customer profile. The maximum length for this value is 254 characters. |
address
|
The physical address associated with the customer profile. For maximum length constraints, see
Customer addresses.
The |
phone_
|
The phone number associated with the customer profile. The phone number must be valid and can contain
9–16 digits, with an optional |
reference_
|
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. |
note
|
A custom note associated with the customer profile. |
birthday
|
The birthday associated with the customer profile, in |
tax_
|
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 |
Response Fields
Name | Description |
---|---|
errors
|
Any errors that occurred during the request. |
customer
|
The created customer. |
Examples
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/customers \
-X POST \
-H 'Square-Version: 2023-01-19' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"given_name": "Amelia",
"family_name": "Earhart",
"email_address": "Amelia.Earhart@example.com",
"address": {
"address_line_1": "500 Electric Ave",
"address_line_2": "Suite 600",
"locality": "New York",
"administrative_district_level_1": "NY",
"postal_code": "10003",
"country": "US"
},
"phone_number": "+1-212-555-4240",
"reference_id": "YOUR_REFERENCE_ID",
"note": "a customer"
}'
{
"customer": {
"id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
"created_at": "2016-03-23T20:21:54.859Z",
"updated_at": "2016-03-23T20:21:54.859Z",
"given_name": "Amelia",
"family_name": "Earhart",
"email_address": "Amelia.Earhart@example.com",
"address": {
"address_line_1": "500 Electric Ave",
"address_line_2": "Suite 600",
"locality": "New York",
"administrative_district_level_1": "NY",
"postal_code": "10003",
"country": "US"
},
"phone_number": "+1-212-555-4240",
"reference_id": "YOUR_REFERENCE_ID",
"note": "a customer",
"preferences": {
"email_unsubscribed": false
},
"creation_source": "THIRD_PARTY",
"version": 0
}
}
Error Descriptions
400 Bad request |
INVALID_ The provided email address is invalid. |
> |
400 Bad request |
INVALID_ The provided phone number is invalid. |
> |
{
"errors": [
{
"code": "INVALID_EMAIL_ADDRESS",
"category": "INVALID_REQUEST_ERROR"
}
]
}