Customers

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


AttributeTypeDescription
idintThe unique identifier of the customer.
addressesarrayList of all billing and shipping addresses which are associated with the customer. expandable
default_source_idint||nullUnique identifier of the customer's default payment method expandable
default_sourcearray||nullThe customer's default payment method
organizationint||nullThe customer’s organization identifier expandable
subscriptionsarrayList of all the customer's subscriptions. expandable
display_namestring||nullThe customer's display name.
usernamestring||nullThe customer's username. Must contain only alpha-numeric characters, dashes or underscores, as well as being unique under the same account.
emailstringThe customer's email address.
email_confirmboolA boolean on whether the customer's email address was confirmed.
email_hardbounceboolA boolean on whether delivery attempts on the customer's email address result in permanent failures (ie: hard bounces).
first_namestring||nullThe customer’s first name.
last_namestring||nullThe customer’s last name.
mail_marketingboolA boolean on whether the customer authorized to received mail marketing.
metadataarraySet 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.
namestring||nullThe customer's full name.
old_provider_idstring||nullThe identifier of customer before migrating into Pelcro, this field will be searchable from the platform.
is_importedbool||nullDefine if the customer is imported or not
phonestring||nullThe customer’s phone.
phone_confirmboolA boolean on whether the customer's phone was confirmed.
salutationstring||nullThe customer’s salutation.
languagestring||nullThe customer's language.
titlestring||nullThe customer’s title.
tinstring||nullThe customer's tax identification number.
profile_photostring||nullThe customer's profile picture link.
tele_marketingboolA boolean on whether the customer authorized to received telemarketing.
timezonestring||nullTimezone of the customer, as a Zone ID or supported alias. See list of supported timezones.
has_passwordboolA boolean on whether a password is set for the customer account.
password_last_updated_attimestamp||nullTime at which password was last updated.
last_login_attimestamp||nullTime at which the customer last logged in to the website.
last_login_methodstring||nullThe method the customer used in their last login.
created_attimestampTime at which the customer was created.
updated_attimestampTime at which the customer was last updated.