Customer Object - Square API Reference

Name	Description
`id string`	A unique Square-assigned ID for the customer profile.
`created_at string`	Read only The timestamp when the customer profile was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`updated_at string`	Read only The timestamp when the customer profile was last updated, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`cards Card [ ]`	Payment details of cards stored on file for the customer profile.
`given_name string`	The given (i.e., first) name associated with the customer profile.
`family_name string`	The family (i.e., 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 Address`	The physical address associated with the customer profile.
`phone_number string`	The 11-digit phone number associated with the customer profile.
`birthday string`	The birthday associated with the customer profile, in RFC 3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st 1998.
`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 CustomerPreferences`	Represents general customer preferences.
`groups CustomerGroupInfo [ ]` Deprecated	The customer groups and segments the customer belongs to. This deprecated field has been replaced with the dedicated `group_ids` for customer groups and the dedicated `segment_ids` field for customer segments. You can retrieve information about a given customer group and segment respectively using the Customer Groups API and Customer Segments API.
`creation_source string`	A creation source represents the method used to create the customer profile.
`group_ids string [ ]` Beta	The IDs of customer groups the customer belongs to.
`segment_ids string [ ]` Beta	The IDs of segments the customer belongs to.

A unique Square-assigned ID for the customer profile.

Read only The timestamp when the customer profile was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Read only The timestamp when the customer profile was last updated, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Payment details of cards stored on file for the customer profile.

The given (i.e., first) name associated with the customer profile.


          
  
  
            family_name
          


        

        
    string

The family (i.e., last) name associated with the customer profile.

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.

The physical address associated with the customer profile.


          
  
  
            phone_number
          


        

        
    string

The 11-digit phone number associated with the customer profile.

The birthday associated with the customer profile, in RFC 3339 format. Year is optional, timezone and times are not allowed. For example: 0000-09-01T00:00:00-00:00 indicates a birthday on September 1st. 1998-09-01T00:00:00-00:00 indications a birthday on September 1st 1998.


          
  
  
            reference_id
          


        

        
    string

An optional, second ID used to associate the customer profile with an entity in another system.

A custom note associated with the customer profile.


          
  
  
            preferences
          


        

        
    
      CustomerPreferences

Represents general customer preferences.


          
  
  
            groups
          


        

        
      
        CustomerGroupInfo [ ]

Deprecated

The customer groups and segments the customer belongs to. This deprecated field has been replaced with the dedicated group_ids for customer groups and the dedicated segment_ids field for customer segments. You can retrieve information about a given customer group and segment respectively using the Customer Groups API and Customer Segments API.


          
  
  
            creation_source
          


        

        
    string

A creation source represents the method used to create the customer profile.

Beta

The IDs of customer groups the customer belongs to.


          
  
  
            segment_ids
          


        

        
      string [ ]

Beta

The IDs of segments the customer belongs to.

Object Index

You are viewing an old version of the API

All Versions

Customer

Properties

Share Feedback

Object Index You are viewing an old version of the API 2020-11-18 Version 2020-11-18 All Versions Customer

Properties

Share Feedback

Object Index

You are viewing an old version of the API

All Versions

Customer