Home > @vsf-enterprise/bigcommerce-api > User

# User interface

Customer information.

Signature:

export interface User 

# Properties

Property Type Description
accepts_product_review_abandoned_cart_emails? boolean (Optional) It determines if the customer is signed up to receive product review or abandoned cart emails or recieve both emails.
address_count? number (Optional) Total number of customer addresses.
addresses? UserAddress[] (Optional) Array of customer addresses. Limited to 10.
attribute_count? number (Optional) Total number of customer attributes.
authentication? Authentication (Optional) Authentication information.
channel_ids? number[] (Optional) Array of channel ids the Customer has access to.
company? string (Optional) The company of the customer.
customer_group_id? number (Optional) ID of the group which this customer belongs to.
date_created? string (Optional) The date of which the customer was created.
date_modified? string (Optional) The date on which the customer was modified.
email string The email of the customer. Must be unique.
first_name string The first name of the customer.
form_fields? CustomerIdFormField[] (Optional) Customer form fields.
id? number (Optional) The unique numeric ID of the customer.
last_name string The last name of the customer.
notes? string (Optional) The customer notes.
phone? string (Optional) The phone number of the customer.
registration_ip_address? string (Optional) The IP address from which this customer was registered.
store_credit_amounts? Array<{ amount: number; }> (Optional) Store credit.
tax_exempt_category? string (Optional) The tax exempt category code for the customer.