customer.md

Customer

Represents a Square customer profile in the Customer Directory of a Square seller.

Structure

Customer

Fields

Name	Type	Tags	Description	Getter
Id	String	Optional	A unique Square-assigned ID for the customer profile. If you need this ID for an API request, use the ID returned when you created the customer profile or call the SearchCustomers or ListCustomers endpoint.	String getId()
CreatedAt	String	Optional	The timestamp when the customer profile was created, in RFC 3339 format.	String getCreatedAt()
UpdatedAt	String	Optional	The timestamp when the customer profile was last updated, in RFC 3339 format.	String getUpdatedAt()
Cards	List<Card>	Optional	Payment details of the credit, debit, and gift cards stored on file for the customer profile. DEPRECATED at version 2021-06-16 and will be RETIRED at version 2024-12-18. Replaced by calling ListCards (for credit and debit cards on file) or ListGiftCards (for gift cards on file) and including the customer_id query parameter. For more information, see Migration notes.	List getCards()
GivenName	String	Optional	The given name (that is, the first name) associated with the customer profile.	String getGivenName()
FamilyName	String	Optional	The family name (that is, the last name) associated with the customer profile.	String getFamilyName()
Nickname	String	Optional	A nickname for the customer profile.	String getNickname()
CompanyName	String	Optional	A business name associated with the customer profile.	String getCompanyName()
EmailAddress	String	Optional	The email address associated with the customer profile.	String getEmailAddress()
Address	Address	Optional	Represents a postal address in a country. For more information, see Working with Addresses.	Address getAddress()
PhoneNumber	String	Optional	The phone number associated with the customer profile.	String getPhoneNumber()
Birthday	String	Optional	The birthday associated with the customer profile, in YYYY-MM-DD format. For example, 1998-09-21 represents September 21, 1998, and 0000-09-21 represents September 21 (without a birth year).	String getBirthday()
ReferenceId	String	Optional	An optional second ID used to associate the customer profile with an entity in another system.	String getReferenceId()
Note	String	Optional	A custom note associated with the customer profile.	String getNote()
Preferences	CustomerPreferences	Optional	Represents communication preferences for the customer profile.	CustomerPreferences getPreferences()
CreationSource	String	Optional	Indicates the method used to create the customer profile.	String getCreationSource()
GroupIds	List<String>	Optional	The IDs of customer groups the customer belongs to.	List getGroupIds()
SegmentIds	List<String>	Optional	The IDs of customer segments the customer belongs to.	List getSegmentIds()
Version	Long	Optional	The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership and cards on file.	Long getVersion()
TaxIds	CustomerTaxIds	Optional	Represents the tax ID associated with a customer profile. The corresponding tax_ids field is available only for customers of sellers in EU countries or the United Kingdom. For more information, see Customer tax IDs.	CustomerTaxIds getTaxIds()

Example (as JSON)

{
  "id": "id8",
  "created_at": "created_at6",
  "updated_at": "updated_at6",
  "cards": [
    {
      "id": "id8",
      "card_brand": "DISCOVER",
      "last_4": "last_40",
      "exp_month": 152,
      "exp_year": 144
    }
  ],
  "given_name": "given_name0"
}