Object Index

You are viewing an old version of the API

2021-07-21

Version 2021-07-21

• All Versions

Customer

A unique Square-assigned ID for the customer profile.

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

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

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 Migrate to the Cards API and Gift Cards API.

The given (i.e., first) name associated with the customer profile.

The family (i.e., last) name associated with the customer profile.

A nickname for the customer profile.

A business name associated with the customer profile.

The email address associated with the customer profile.

The physical address associated with the customer profile.

The 11-digit phone number associated with the customer profile.

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.

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

A custom note associated with the customer profile.

Represents general customer preferences.

A creation source represents the method used to create the customer profile.

The IDs of customer groups the customer belongs to.

The IDs of segments the customer belongs to.

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.