Learn more about the customer object.
This object represents your subscribers or customers. It stores various information including contact details (name, email, phone, addresses), billing information (default payment method), marketing preferences, and custom data points which can you can define and store via the metadata
attribute.
Unless otherwise specified, all attributes of type timestamp
hold a standard Unix time, representing the number of seconds that have elapsed since 00:00:00 UTC on 1st January 1970.
Customer object
Attribute | Type | Description |
---|---|---|
id | int | The unique identifier of the customer. |
addresses | array | List of all billing and shipping addresses which are associated with the customer. expandable |
default_source_id | int||null | Unique identifier of the customer's default payment method expandable |
default_source | array||null | The customer's default payment method |
organization | int||null | The customer’s organization identifier expandable |
subscriptions | array | List of all the customer's subscriptions. expandable |
display_name | string||null | The customer's display name. |
username | string||null | The customer's username. Must contain only alpha-numeric characters, dashes or underscores, as well as being unique under the same account. |
string | The customer's email address. | |
email_confirm | bool | A boolean on whether the customer's email address was confirmed. |
email_hardbounce | bool | A boolean on whether delivery attempts on the customer's email address result in permanent failures (ie: hard bounces). |
first_name | string||null | The customer’s first name. |
last_name | string||null | The customer’s last name. |
mail_marketing | bool | A boolean on whether the customer authorized to received mail marketing. |
metadata | array | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
name | string||null | The customer's full name. |
old_provider_id | string||null | The identifier of customer before migrating into Pelcro, this field will be searchable from the platform. |
is_imported | bool||null | Define if the customer is imported or not |
phone | string||null | The customer’s phone. |
phone_confirm | bool | A boolean on whether the customer's phone was confirmed. |
salutation | string||null | The customer’s salutation. |
language | string||null | The customer's language. |
title | string||null | The customer’s title. |
tin | string||null | The customer's tax identification number. |
profile_photo | string||null | The customer's profile picture link. |
tele_marketing | bool | A boolean on whether the customer authorized to received telemarketing. |
timezone | string||null | Timezone of the customer, as a Zone ID or supported alias. See list of supported timezones. |
has_password | bool | A boolean on whether a password is set for the customer account. |
password_last_updated_at | timestamp||null | Time at which password was last updated. |
last_login_at | timestamp||null | Time at which the customer last logged in to the website. |
last_login_method | string||null | The method the customer used in their last login. |
created_at | timestamp | Time at which the customer was created. |
updated_at | timestamp | Time at which the customer was last updated. |