Customer

November 20, 2019 ยท View on GitHub

Description

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

Properties

NameTypeDescriptionNotes
idStringA unique, Square-assigned object ID.
createdAtStringThe time when the customer profile was created, in RFC 3339 format.
updatedAtStringThe time when the customer profile was last updated, in RFC 3339 format.
cardsList<Card>Payment details of cards stored on file for the customer profile.[optional]
givenNameStringThe given (i.e., first) name associated with the customer profile.[optional]
familyNameStringThe family (i.e., last) name associated with the customer profile.[optional]
nicknameStringA nickname for the customer profile.[optional]
companyNameStringA business name associated with the customer profile.[optional]
emailAddressStringThe email address associated with the customer profile.[optional]
addressAddressThe physical address associated with the customer profile.[optional]
phoneNumberStringThe 11-digit phone number associated with the customer profile.[optional]
birthdayStringThe 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.[optional]
referenceIdStringAn optional, second ID used to associate the customer profile with an entity in another system.[optional]
noteStringA custom note associated with the customer profile.[optional]
preferencesCustomerPreferencesRepresents general customer preferences.[optional]
groupsList<CustomerGroupInfo>The groups the customer belongs to.[optional]
creationSourceStringA creation source represents the method used to create the customer profile. See CustomerCreationSource for possible values[optional]