Skip to main content

Interface: Customer

Properties​

analytics_data​

analytics_data: AnalyticsData

An object containing analytics data associated with the customer.

apply_credit_to_next_recurring_charge​

apply_credit_to_next_recurring_charge: boolean

A boolean that indicates whether Recharge credits will be applied to the next recurring charge

apply_credit_to_next_recurring_charge_channel?​

optional apply_credit_to_next_recurring_charge_channel: string

A string that indicates which channel apply_credit_to_next_recurring_charge was set

backup_payment_methods_enabled​

backup_payment_methods_enabled: boolean

Backup payment methods enabled

can_add_payment_method​

can_add_payment_method: boolean

Whether the customer can add a payment method

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?​

optional include: object

Additional information as requested

addresses?​

optional addresses: Address[]

announcements?​

optional announcements: Announcement[]

metafields?​

optional metafields: Metafield[]

payment_methods?​

optional payment_methods: PaymentMethod[]

punch_card_progress?​

optional punch_card_progress: PunchCardProgress

referral_info?​

optional referral_info: ReferralInfo

subscriptions?​

optional subscriptions: Subscription[]

last_name​

last_name: string

The customer’s last name.

payment_method_fallback_on_failure_disabled​

payment_method_fallback_on_failure_disabled: boolean

Disable payment method fallback on failure

phone​

phone: string

The customer's phone number

subscription_related_charge_streak: number

The number of consecutive subscription-related charges processed for this customer, while they retain at least one active subscription. When all subscriptions for this customer are cancelled or expired, this value will reset to zero.

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.

tax_exempt​

tax_exempt: boolean

Whether the customer is tax exempt or not

updated_at​

updated_at: string

The date and time when the customer was last updated.