SquareConnect::Customer

March 27, 2019 ยท View on GitHub

Description

Represents one of a business's customers, which can have one or more cards on file associated with it.

Properties

NameTypeDescriptionNotes
idStringThe customer's unique ID.
created_atStringThe time when the customer was created, in RFC 3339 format.
updated_atStringThe time when the customer was last updated, in RFC 3339 format.
cardsArray<Card>The payment details of the customer's cards on file.[optional]
given_nameStringThe customer's given (i.e., first) name.[optional]
family_nameStringThe customer's family (i.e., last) name.[optional]
nicknameStringThe customer's nickname.[optional]
company_nameStringThe name of the customer's company.[optional]
email_addressStringThe customer's email address.[optional]
addressAddressThe customer's physical address.[optional]
phone_numberStringThe customer's phone number.[optional]
birthdayStringThe customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.[optional]
reference_idStringA second ID you can set to associate the customer with an entity in another system.[optional]
noteStringA note to associate with the customer.[optional]
preferencesCustomerPreferencesThe customer's preferences.[optional]
groupsArray<CustomerGroupInfo>The groups the customer belongs to.[optional]
creation_sourceStringA creation source represents the method used to create the customer profile. See CustomerCreationSource for possible values[optional]