Attributes

AttributeDescription
id intUnique identifier for the object.
default_source intUnique identifier of the customer's default payment method expandable
addresses arrayList of all billing and shipping addresses which are associated with the customer. expandable
display_name stringA display name that can be used by the customer, the primary use case of this is for commenting systems.
email stringThe customer’s email address.
email_confirm boolA boolean on whether the customer's email address was confirmed.
email_hardbounce boolA boolean on whether the customer's email is hardbounce.
first_name stringThe customer’s first name.
last_name stringThe customer’s last name.
mail_marketing boolA boolean on whether the customer authorized to received mail marketing.
metadata objectSet 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 stringThe customer's full name.
old_provider_id stringThe ID of customer before migrating into Pelcro, this field will be searchable from the platform.
phone stringThe customer’s phone.
phone_confirm boolA boolean on whether the customer's phone was confirmed.
salutation stringThe customer’s salutation.
title stringThe customer’s title.
tin stringThe customer's tax identification number.
organization intThe customer’s organization ID expandable
tele_marketing boolA boolean on whether the customer authorized to received telemarketing.
has_password boolA boolean on whether a password is set for the customer account.
password_last_updated_at timestampTime at which password was last updated.
is_imported bool Define if the customer is imported or not
created_at timestampTime at which the object was created.
last_login_at timestampTime at which the customer last logged in to the website
updated_at timestampTime at which the object was last updated.
deleted_at timestampTime at which the object was deleted.
subscriptions arrayList of all the customer's subscriptions. expandable