• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Customer

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

Properties

Name Description
id
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.

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

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

cards
Card [ ]

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 customer_id query parameter. For more information, see Migration notes.

given_name
string

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

family_name
string

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

nickname
string

A nickname for the customer profile.

company_name
string

A business name associated with the customer profile.

email_address
string

The email address associated with the customer profile.

address
Address

The physical address associated with the customer profile.

phone_number
string

The phone number associated with the customer profile. A phone number can contain 9–16 digits, with an optional + prefix.

birthday
string

The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed. For example, 0000-09-21T00:00:00-00:00 represents a birthday on September 21 and 1998-09-21T00:00:00-00:00 represents a birthday on September 21, 1998.

reference_id
string

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

note
string

A custom note associated with the customer profile.

preferences
CustomerPreferences

Represents general customer preferences.

creation_source
string

The method used to create the customer profile.

group_ids
string [ ]

The IDs of customer groups the customer belongs to.

segment_ids
string [ ]

The IDs of segments the customer belongs to.

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.

tax_ids
CustomerTaxIds

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.