Object Index
/ Definition
You are viewing an old version of the API
Customer
Object Index / Definition
Represents a Square customer profile, which can have one or more cards on file associated with it.
Properties
| Name | Description |
|---|---|
id
Required
|
A unique, Square-assigned object ID. |
created_at
Required
|
The time when the customer profile was created, in RFC 3339 format. Examples for January 25th, 2020 6:27.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
Required
|
The time when the customer profile was last updated, in RFC 3339 format. Examples for January 25th, 2020 6:27.34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
cards
|
Payment details of cards stored on file for the customer profile. |
given_name
|
The given (i.e., first) name associated with the customer profile. |
family_name
|
The family (i.e., last) name associated with the customer profile. |
nickname
|
A nickname for the customer profile. |
company_name
|
A business name associated with the customer profile. |
email_address
|
The email address associated with the customer profile. |
address
|
The physical address associated with the customer profile. |
phone_number
|
The 11-digit phone number associated with the customer profile. |
birthday
|
The birthday associated with the customer profile, in RFC-3339 format.
Year is optional, timezone and times are not allowed.
For example: |
reference_id
|
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. |
groups
|
The groups the customer belongs to. |
creation_source
|
A creation source represents the method used to create the customer profile. See CustomerCreationSource for possible values |