<- Object

Object

All versions ->

Customer

Represents a Square customer profile in the Customer Directory of a Square seller.

Link to section

Properties

Link to section

string

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.

Link to section

created_at

string

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

Link to section

updated_at

string

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

Link to section

cards

Deprecated

Payment details of the credit, debit, and gift cards stored on file for the customer profile.

DEPRECATED at version 2021-06-16 and will be RETIRED at version 2024-12-18. Replaced by calling ListCards (for credit and debit cards on file) or ListGiftCards (for gift cards on file) and including the customer_id query parameter. For more information, see Migration notes.

Link to section

given_name

string

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

Link to section

family_name

string

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

Link to section

nickname

string

A nickname for the customer profile.

Link to section

company_name

string

A business name associated with the customer profile.

Link to section

email_address

string

The email address associated with the customer profile.

Link to section

address

The physical address associated with the customer profile.

Link to section

phone_number

string

The phone number associated with the customer profile.

Link to section

birthday

string

The birthday associated with the customer profile, in YYYY-MM-DD format. For example, 1998-09-21 represents September 21, 1998, and 0000-09-21 represents September 21 (without a birth year).

Link to section

reference_id

string

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

Link to section

note

string

A custom note associated with the customer profile.

Link to section

preferences

Represents general customer preferences.

Link to section

creation_source

string

The method used to create the customer profile.

Link to section

group_ids

string [ ]

The IDs of customer groups the customer belongs to.

Link to section

segment_ids

string [ ]

The IDs of customer segments the customer belongs to.

Link to section

version

integer(64-bit)

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.

Link to section

tax_ids

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.