Skip to content

Latest commit

 

History

History
59 lines (50 loc) · 4.57 KB

customer.md

File metadata and controls

59 lines (50 loc) · 4.57 KB

Customer

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

Structure

Customer

Fields

Name Type Tags Description
id string | undefined 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.
createdAt string | undefined Optional The timestamp when the customer profile was created, in RFC 3339 format.
updatedAt string | undefined Optional The timestamp when the customer profile was last updated, in RFC 3339 format.
cards Card[] | undefined Optional Payment details of the credit, debit, and gift cards stored on file for the customer profile.

DEPRECATED at version 2021-06-16. 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.
givenName string | undefined Optional The given name (that is, the first name) associated with the customer profile.
familyName string | undefined Optional The family name (that is, the last name) associated with the customer profile.
nickname string | undefined Optional A nickname for the customer profile.
companyName string | undefined Optional A business name associated with the customer profile.
emailAddress string | undefined Optional The email address associated with the customer profile.
address Address | undefined Optional Represents a postal address in a country.
For more information, see Working with Addresses.
phoneNumber string | undefined Optional The phone number associated with the customer profile. A phone number can contain 9–16 digits, with an optional + prefix.
birthday string | undefined Optional The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed.
For example, 0000-09-21T00:00:00-00:00 represents a birthday on September 21 and 1998-09-21T00:00:00-00:00 represents a birthday on September 21, 1998.
referenceId string | undefined Optional An optional second ID used to associate the customer profile with an
entity in another system.
note string | undefined Optional A custom note associated with the customer profile.
preferences CustomerPreferences | undefined Optional Represents communication preferences for the customer profile.
creationSource string | undefined Optional Indicates the method used to create the customer profile.
groupIds string[] | undefined Optional The IDs of customer groups the customer belongs to.
segmentIds string[] | undefined Optional The IDs of segments the customer belongs to.
version bigint | undefined 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.
taxIds CustomerTaxIds | undefined 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.

Example (as JSON)

{
  "id": null,
  "cards": null,
  "given_name": null,
  "family_name": null,
  "nickname": null,
  "company_name": null,
  "email_address": null,
  "address": null,
  "phone_number": null,
  "birthday": null,
  "reference_id": null,
  "note": null,
  "preferences": null,
  "creation_source": null,
  "group_ids": null,
  "segment_ids": null,
  "version": null,
  "tax_ids": null
}