Object Index
You are viewing an old version of the API
Customer
Object Index
Represents a Square customer profile in the Customer Directory of a Square seller.
Properties
Name | Description |
---|---|
id
|
A unique Square-assigned ID for the customer profile. If you need this ID for an API request, use the ID returned when you created the customer profile or call the SearchCustomers or ListCustomers endpoint. |
created_
|
Read only The timestamp when the customer profile was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
updated_
|
Read only The timestamp when the customer profile was last updated, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
cards
Deprecated
|
Payment details of the credit, debit, and gift cards stored on file for the customer profile. DEPRECATED at version 2021-06-16. Replaced by calling ListCards (for credit and debit cards on file)
or ListGiftCards (for gift cards on file) and including the |
given_
|
The given name (that is, the first name) associated with the customer profile. |
family_
|
The family name (that is, the last name) associated with the customer profile. |
nickname
|
A nickname for the customer profile. |
company_
|
A business name associated with the customer profile. |
email_
|
The email address associated with the customer profile. |
address
|
The physical address associated with the customer profile. |
phone_
|
The phone number associated with the customer profile. |
birthday
|
The birthday associated with the customer profile, in |
reference_
|
An optional second ID used to associate the customer profile with an entity in another system. |
note
|
A custom note associated with the customer profile. |
preferences
|
Represents general customer preferences. |
creation_
|
The method used to create the customer profile. |
group_
|
The IDs of customer groups the customer belongs to. |
segment_
|
The IDs of customer segments the customer belongs to. |
version
|
The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership and cards on file. |
tax_
|
The tax ID associated with the customer profile. This field is present only for customers of sellers in EU countries or the United Kingdom. For more information, see Customer tax IDs. |