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.
Customer object
Attribute | Type | Description |
---|---|---|
id | int | Unique identifier for the object. |
string | The customer's email address. | |
first_name | string | The customer’s first name. |
last_name | string | The customer’s last name. |
default_source | int | Unique identifier of the customer's default payment method expandable |
addresses | array | List of all billing and shipping addresses which are associated with the customer. expandable |
display_name | string | The customer's display name. |
email_confirm | bool | A boolean on whether the customer's email address was confirmed. |
email_hardbounce | bool | A boolean on whether the customer's email is hardbounce. |
mail_marketing | bool | A boolean on whether the customer authorized to received mail marketing. |
metadata | object | 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 | The customer's full name. |
old_provider_id | string | The ID of customer before migrating into Pelcro, this field will be searchable from the platform. |
phone | string | The customer’s phone. |
phone_confirm | bool | A boolean on whether the customer's phone was confirmed. |
salutation | string | The customer’s salutation. |
title | string | The customer’s title. |
tin | string | The customer's tax identification number. |
organization | string | The customer’s organization ID expandable |
tele_marketing | bool | A boolean on whether the customer authorized to received telemarketing. |
has_password | bool | A boolean on whether a password is set for the customer account. |
password_last_updated_at | timestamp | Time at which password was last updated. |
is_imported | bool | Define if the customer is imported or not |
created_at | timestamp | Time at which the object was created. |
last_login_at | timestamp | Time at which the customer last logged in to the website |
updated_at | timestamp | Time at which the object was last updated. |
deleted_at | timestamp | Time at which the object was deleted. |
subscriptions | array | List of all the customer's subscriptions. expandable |
last_login_method | string | The method the customer used in their last login. |
username | string | The customer's username. Must contain only alpha-numeric characters, dashes or underscores, as well as being unique under the same account. |