Skip to main content

Customer

Properties​

analytics_data​

analytics_data: AnalyticsData

An object containing analytics data associated with the customer.

created_at​

created_at: string

The date and time when the customer was created.

email​

email: string

The email address of the customer.

external_customer_id​

external_customer_id: ExternalId

An object containing external ids for the customer record.

first_charge_processed_at​

first_charge_processed_at: string

Date when first charge was processed for the customer.

first_name​

first_name: string

The customer’s first name.

has_payment_method_in_dunning​

has_payment_method_in_dunning: boolean

A boolean that indicates if the customer has a payment method that is in dunning (failed charge).

has_valid_payment_method​

has_valid_payment_method: boolean

Is the payment method valid or not.

hash​

hash: string

The unique string identifier used in a customers portal link.

id​

id: number

Unique numeric identifier for the Customer.

include?​

include?: Object

Additional information as requested

Type declaration​

addresses?​

addresses?: Address[]

metafields?​

metafields?: Metafield[]

payment_methods?​

payment_methods?: PaymentMethod[]

subscriptions?​

subscriptions?: Subscription[]

last_name​

last_name: string

The customer’s last name.

subscriptions_active_count​

subscriptions_active_count: number

The number of active subscriptions on addresses associated with the customer.

subscriptions_total_count​

subscriptions_total_count: number

The total number of subscriptions created on addresses associated with the customer.

updated_at​

updated_at: string

The date and time when the customer was last updated.

Generated using typedoc-plugin-markdown and TypeDoc