Please enable JavaScript to view this site.

Navigation: Schema: Customers > Tables

Customers: Chargebee Customers

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_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

 

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_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

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_status

string

VAT Number Status

 

vat_number_validated_time

datetime

VAT Number Validated Time

 

vat_number

string

VAT Number

 

 

15-06-2022 22:32 Version 22.1.46-BETA+3385

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

  
Disclaimer