Object Index / Definition

You are viewing an old version of the API
Customer

Represents a Square customer profile, which can have one or more cards on file associated with it

Properties

Name Description
id
string

Required

A unique, Square-assigned object ID.

created_at
string

Required

The time when the customer profile was created, in RFC 3339 format.

updated_at
string

Required

The time when the customer profile was last updated, in RFC 3339 format.

address
Address

The physical address associated with the customer profile.

birthday
string

The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: 0000-09-01T00:00:00-00:00 indicates a birthday on September 1st. 1998-09-01T00:00:00-00:00 indications a birthday on September 1st 1998.

cards
Card [ ]

Payment details of cards stored on file for the customer profile.

company_name
string

A business name associated with the customer profile.

creation_source
string

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

email_address
string

The email address associated with the customer profile.

family_name
string

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

given_name
string

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

groups
Customer​Group​Info [ ]

The groups the customer belongs to.

nickname
string

A nickname for the customer profile.

note
string

A custom note associated with the customer profile.

phone_number
string

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

preferences
Customer​Preferences

Represents general customer preferences.

reference_id
string

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

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?