Customer

March 27, 2019 ยท View on GitHub

squareconnect.models.customer

Description

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

Properties

NameTypeDescriptionNotes
idstrThe customer's unique ID.
created_atstrThe time when the customer was created, in RFC 3339 format.
updated_atstrThe time when the customer was last updated, in RFC 3339 format.
cardslist[Card]The payment details of the customer's cards on file.[optional]
given_namestrThe customer's given (i.e., first) name.[optional]
family_namestrThe customer's family (i.e., last) name.[optional]
nicknamestrThe customer's nickname.[optional]
company_namestrThe name of the customer's company.[optional]
email_addressstrThe customer's email address.[optional]
addressAddressThe customer's physical address.[optional]
phone_numberstrThe customer's phone number.[optional]
birthdaystrThe 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_idstrA second ID you can set to associate the customer with an entity in another system.[optional]
notestrA note to associate with the customer.[optional]
preferencesCustomerPreferencesThe customer's preferences.[optional]
groupslist[CustomerGroupInfo]The groups the customer belongs to.[optional]
creation_sourcestrA creation source represents the method used to create the customer profile. See CustomerCreationSource for possible values[optional]

[Back to Model list] [Back to API list] [Back to README]