Customers: Chargebee Customers

active_id

string(50)

☐

Represents the id of the active version of the customer resource.

allow_direct_debit

boolean

Allow Direct Debit

☐

Whether the customer can pay via Direct Debit.

auto_close_invoices

boolean

☐

Override for this customer, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the subscription level which takes precedence.

auto_collection

string(30)

Auto Collection

☐

backup_payment_source_id

string

Backup Payment Source ID

☐

billing_address_city

string(50)

Billing Address City

☐

billing_address_company

string(250)

Billing Address Company

☐

billing_address_country

string(50)

Billing Address Country

☐

billing_address_email

string(70)

Billing Address Email

☐

billing_address_first_name

string(150)

Billing Address First Name

☐

billing_address_last_name

string(150)

Billing Address Last Name

☐

billing_address_line1

string(150)

Billing Address Line 1

☐

billing_address_line2

string(150)

Billing Address Line 2

☐

billing_address_line3

string(150)

Billing Address Line 3

☐

billing_address_phone

string(50)

Billing Address Phone

☐

billing_address_state_code

string(50)

☐

billing_address_state

string(50)

Billing Address State

☐

billing_address_validation_status

string(30)

Billing Address Validation Status

☐

billing_address_zip

string(20)

☐

billing_date_mode

string

Billing Date Mode

☐

billing_date

int64

Billing Date

☐

billing_day_of_week_mode

string

Billing Day of Week Mode

☐

billing_day_of_week

string

Billing Day of Week

☐

business_customer_without_vat_number

boolean

Business Customer Without VAT Number

☐

business_entity_id

string(50)

☐

The unique ID of the business entity of this subscription. This is always the same as the business entity of the customer.

channel

string(30)

☐

The subscription channel this object originated from and is maintained in. Possible values are: web, app_store or play_store.

child_account_access_portal_download_invoices

string

Child Account Access Portal Download Invoices

☐

child_account_access_portal_edit_subscriptions

string

Child Account Access Portal Edit Subscriptions

☐

child_account_access_send_invoice_emails

boolean

Child Account Access Send Invoice Emails

☐

child_account_access_send_payment_emails

boolean

Child Account Access Send Payment Emails

☐

child_account_access_send_subscription_emails

boolean

Child Account Access Send Subscription Emails

☐

client_profile_id

string

Client Profile ID

☐

company

string(250)

Company

☐

Company name of the customer.

consolidated_invoicing

boolean

Consolidated Invoicing

☐

created_at

datetime

Created at

☐

created_from_ip

string

Created From IP

☐

customer_type

string

Customer Type

☐

deleted

boolean

Deleted

☐

einvoicing_method

string(30)

☐

Determines whether to send e-invoice manually or automatic. Possible values are: automatic, manual or site_default.

email

string(70)

Email

☐

Email of the customer. Configured email notifications will be sent to this email.

entity_code

string(30)

Entity Code

☐

entity_identifier_scheme

string(50)

☐

The Peppol BIS scheme associated with the vat_number of the customer. This helps identify the specific type of customer entity.

entity_identifier_standard

string(50)

☐

The standard used for specifying the entity_identifier_scheme. Currently only iso6523-actorid-upis is supported and is used by default when not provided.

excess_payments

decimal

Excess Payments

☐

exempt_number

string(100)

Exempt Number

☐

first_name

string(150)

First Name

☐

First name of the customer.

fraud_flag

string

Fraud Flag

☐

id

string(50)

ID

☑

The unique identifier of the customer resource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier.

invoice_notes

string(2000)

Invoice Notes

☐

is_einvoice_enabled

boolean

☐

Determines whether the customer is e-invoiced. When set to true or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country). When set to false, the customer is not e-invoiced even if e-invoicing is enabled for their country.

is_location_valid

boolean

Is Location Valid

☐

last_name

string(150)

Last Name

☐

Last name of the customer.

locale

string(50)

Locale

☐

meta_data

string

Meta Data

☐

net_term_days

int32

Net Term Days

☐

The number of days within which the customer has to make payment for the invoice.

offline_payment_method

string(30)

Offline Payment Method

☐

parent_account_access_portal_download_child_invoices

string

Parent Account Access Portal Download Child Invoices

☐

parent_account_access_portal_edit_child_subscriptions

string

Parent Account Access Portal Edit Child Subscriptions

☐

parent_account_access_send_invoice_emails

boolean

Parent Account Access Send Invoice Emails

☐

parent_account_access_send_payment_emails

boolean

Parent Account Access Send Payment Emails

☐

parent_account_access_send_subscription_emails

boolean

Parent Account Access Send Subscription Emails

☐

payment_method_gateway_account_id

string

Payment Method Gateway Account ID

☐

payment_method_gateway

string

Payment Method Gateway

☐

payment_method_reference_id

string

Payment Method Reference ID

☐

payment_method_status

string

Payment Method Status

☐

payment_method_type

string

Payment Method Type

☐

phone

string(50)

Phone

☐

Phone number of the customer.

pii_cleared

string

PII Cleared

☐

preferred_currency_code

string

Preferred Currency Code

☐

primary_payment_source_id

string

Primary Payment Source ID

☐

promotional_credits

decimal

Promotional Credits

☐

refundable_credits

decimal

Refundable Credits

☐

registered_for_gst

boolean

Registered For GST

☐

relationship_invoice_owner_id

string

Relationship Invoice Owner ID

☐

relationship_parent_id

string

Relationship Parent ID

☐

relationship_payment_owner_id

string

Relationship Payment Owner ID

☐

resource_version

int64

Resource Version

☐

taxability

string(30)

Taxability

☐

unbilled_charges

decimal

Unbilled Charges

☐

updated_at

datetime

Updated at

☐

use_default_hierarchy_settings

boolean

Use Default Hierarchy Settings

☐

vat_number_prefix

string(10)

☐

An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with billing_address country as XI (which is United Kingdom - Northern Ireland).

vat_number_status

string(30)

VAT Number Status

☐

vat_number_validated_time

datetime

VAT Number Validated Time

☐

Returns the recent VAT number validation time.

vat_number

string(20)

VAT Number

☐

The VAT/tax registration number for the customer. For customers with billing_address country as XI (which is United Kingdom - Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix.