Create customer
Creates a new customer for a business, which can have associated cards on file
You must provide at least one of the following values in your request to this endpoint:
given_namefamily_namecompany_nameemail_addressphone_number
Request Body
| Name | Description |
|---|---|
address
|
The physical address associated with the customer profile. |
birthday
|
The birthday associated with the customer profile, in RFC-3339 format.
Year is optional, timezone and times are not allowed.
For example: |
company_name
|
A business name associated with the customer profile. |
email_address
|
The email address associated with the customer profile. |
family_name
|
The family (i.e., last) name associated with the customer profile. |
given_name
|
The given (i.e., first) name associated with the customer profile. |
idempotency_key
|
The idempotency key for the request. See the Idempotency guide for more information. |
nickname
|
A nickname for the customer profile. |
note
|
A custom note associated with the customer profile. |
phone_number
|
The 11-digit phone number associated with the customer profile. |
reference_id
|
An optional, second ID used to associate the customer profile with an entity in another system. |
Response Fields
| Name | Description |
|---|---|
customer
|
The created customer. |
errors
|
Any errors that occurred during the request. |
Examples
- cURL
- Ruby
- Python
curl https://connect.squareup.com/v2/customers \
-X POST \
-H 'Square-Version: 2019-11-20' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-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"
}
}