Skip to content

customer.md

Latest commit

 

History

History
60 lines (51 loc) · 3.53 KB

customer.md

File metadata and controls

60 lines (51 loc) · 3.53 KB
Raw

Customer

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

Structure

Customer

Fields

Name Type Tags Description
id string Optional A unique Square-assigned ID for the customer profile.
created_at string Optional The timestamp when the customer profile was created, in RFC 3339 format.
updated_at string Optional The timestamp when the customer profile was last updated, in RFC 3339 format.
cards List of Card 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 Migrate to the Cards API and Gift Cards API.
given_name string Optional The given (i.e., first) name associated with the customer profile.
family_name string Optional The family (i.e., last) name associated with the customer profile.
nickname string Optional A nickname for the customer profile.
company_name string Optional A business name associated with the customer profile.
email_address string Optional The email address associated with the customer profile.
address Address Optional Represents a physical address.
phone_number string Optional The 11-digit phone number associated with the customer profile.
birthday string 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.
reference_id string Optional An optional second ID used to associate the customer profile with an
entity in another system.
note string Optional A custom note associated with the customer profile.
preferences Customer Preferences Optional Represents communication preferences for the customer profile.
creation_source str (Customer Creation Source) Optional Indicates the method used to create the customer profile.
group_ids List of string Optional The IDs of customer groups the customer belongs to.
segment_ids List of string Optional The IDs of segments the customer belongs to.
version long|int 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.

Example (as JSON)

{
  "id": "id0",
  "created_at": "created_at2",
  "updated_at": "updated_at4",
  "cards": [
    {
      "id": "id7",
      "card_brand": "EBT",
      "last_4": "last_49",
      "exp_month": 79,
      "exp_year": 217
    },
    {
      "id": "id8",
      "card_brand": "FELICA",
      "last_4": "last_40",
      "exp_month": 78,
      "exp_year": 218
    }
  ],
  "given_name": "given_name2"
}