Please enable JavaScript to view this site.

Chargebee API Data Model

Navigation: Schema: Customers > Tables

Customers: Chargebee Customers

 Contents Previous Home Next More

Catalog: Chargebee

Schema: Customers

Primary Keys: id

Label: Customers

Can retrieve data and change data using insert, update and delete.

Select Chargebee API URL: /customers

Insert Chargebee API URL: /customers

Update Chargebee API URL: /customers

Delete Chargebee API URL: /customers/{id}/delete

Field Selection Method: NotRequired

Base Path: list[*].customer

Table Columns

The columns of the table Customers are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert or update.

Name

Data Type

Label

Required

Documentation

allow_direct_debit

boolean

Allow Direct Debit

☐

 

auto_collection

string

Auto Collection

☐

 

backup_payment_source_id

string

Backup Payment Source ID

☐

 

billing_address_city

string

Billing Address City

☐

 

billing_address_company

string

Billing Address Company

☐

 

billing_address_country

string

Billing Address Country

☐

 

billing_address_email

string

Billing Address Email

☐

 

billing_address_first_name

string

Billing Address First Name

☐

 

billing_address_last_name

string

Billing Address Last Name

☐

 

billing_address_line1

string

Billing Address Line 1

☐

 

billing_address_line2

string

Billing Address Line 2

☐

 

billing_address_line3

string

Billing Address Line 3

☐

 

billing_address_phone

string

Billing Address Phone

☐

 

billing_address_state

string

Billing Address State

☐

 

billing_address_validation_status

string

Billing Address Validation Status

☐

 

billing_address_zip

string

 

☐

 

billing_date

int64

Billing Date

☐

 

billing_date_mode

string

Billing Date Mode

☐

 

billing_day_of_week

string

Billing Day of Week

☐

 

billing_day_of_week_mode

string

Billing Day of Week Mode

☐

 

business_customer_without_vat_number

boolean

Business Customer Without VAT Number

☐

 

cf_chamber_of_commerce

string

 

☐

 

cf_exact_id

int64

 

☐

 

cf_guid

string

 

☐

 

cf_tier

string

 

☐

 

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

Company

☐

 

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

☐

 

email

string

Email

☐

 

entity_code

string

Entity Code

☐

 

excess_payments

decimal

Excess Payments

☐

 

exempt_number

string

Exempt Number

☐

 

first_name

string

First Name

☐

 

fraud_flag

string

Fraud Flag

☐

 

id

string

ID

☑

 

invoice_notes

string

Invoice Notes

☐

 

is_location_valid

boolean

Is Location Valid

☐

 

last_name

string

Last Name

☐

 

locale

string

Locale

☐

 

meta_data

string

Meta Data

☐

 

net_term_days

int32

Net Term Days

☐

 

offline_payment_method

string

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

string

Payment Method Gateway

☐

 

payment_method_gateway_account_id

string

Payment Method Gateway Account ID

☐

 

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

Phone

☐

 

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

Taxability

☐

 

unbilled_charges

decimal

Unbilled Charges

☐

 

updated_at

datetime

Updated at

☐

 

use_default_hierarchy_settings

boolean

Use Default Hierarchy Settings

☐

 

vat_number

string

VAT Number

☐

 

vat_number_status

string

VAT Number Status

☐

 

vat_number_validated_time

datetime

VAT Number Validated Time

☐

 

 

12-12-2020 18:45 Version 20.1.301-BETA+3023