Square · Schema

Square Customer

Represents a Square customer profile in the Customer Directory of a Square seller. Customers can be associated with payments, orders, loyalty programs, gift cards, and bookings.

BookingsCatalogCheckoutCustomersDisputesEcommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrdersPaymentsPoint of SaleRefundsRetailSubscriptionsTeamTerminalWebhooks

Properties

Name Type Description
id string A unique Square-assigned ID for the customer profile.
created_at string The timestamp when the customer profile was created, in RFC 3339 format.
updated_at string The timestamp when the customer profile was last updated, in RFC 3339 format.
given_name string The given name (that is, the first name) associated with the customer profile.
family_name string The family name (that is, the last name) associated with the customer profile.
nickname string A nickname for the customer profile.
company_name string A business name associated with the customer profile.
email_address string The email address associated with the customer profile.
address object The physical address associated with the customer profile.
phone_number string The phone number associated with the customer profile.
birthday string 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).
reference_id string An optional second ID used to associate the customer profile with an entity in another system.
note string A custom note associated with the customer profile.
preferences object Represents general customer preferences.
creation_source string The method used to create the customer profile.
group_ids array The IDs of customer groups the customer belongs to.
segment_ids array The IDs of customer segments the customer belongs to.
version integer The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile.
tax_ids object The tax IDs associated with the customer profile. This field is available for customers of sellers in EU countries or the United Kingdom.
View JSON Schema on GitHub