Square · Example Payload

Customer Example

RestaurantBookingsCatalogCheckoutCustomersDisputesE-CommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrderPaymentsPoint-of-SaleRefundsRetailSubscriptionTeamTerminalWebhook

Customer Example is an example object payload from Square, with 19 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idcreated_atupdated_atgiven_namefamily_namenicknamecompany_nameemail_addressaddressphone_numberbirthdayreference_idnotepreferencescreation_sourcegroup_idssegment_idsversiontax_ids

Example Payload

{
  "id": "A1B2C3D4E5F6",
  "created_at": "2026-03-15T14:30:00Z",
  "updated_at": "2026-03-15T14:30:00Z",
  "given_name": "sample-value",
  "family_name": "sample-value",
  "nickname": "sample-value",
  "company_name": "sample-value",
  "email_address": "buyer@example.com",
  "address": {
    "address_line_1": "sample-value",
    "address_line_2": "sample-value",
    "address_line_3": "sample-value",
    "locality": "sample-value",
    "sublocality": "sample-value",
    "administrative_district_level_1": "sample-value",
    "postal_code": "sample-value",
    "country": "US"
  },
  "phone_number": "sample-value",
  "birthday": "sample-value",
  "reference_id": "A1B2C3D4E5F6",
  "note": "Sample Square record.",
  "preferences": {
    "email_unsubscribed": false
  },
  "creation_source": "MARKETING",
  "group_ids": [
    "sample-value",
    "sample-value"
  ],
  "segment_ids": [
    "sample-value",
    "sample-value"
  ],
  "version": 825,
  "tax_ids": {
    "eu_vat": "sample-value"
  }
}