Customers: Chargebee Customers
insert update delete REST
- Catalog:
Chargebee - Schema:
Customers - Primary Keys:
id - Label: Customers
Can retrieve data and change data using insert, update and delete.
API Source
- Endpoint:
/customers
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 and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
active_ |
varchar2 |
itgen_cbe_active_id | Represents the id of the active version of the customer resource. | ||
allow_ |
char |
Allow Direct Debit | Whether the customer can pay via Direct Debit. | ||
auto_ |
char |
itgen_cbe_auto_close_invoices | 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_ |
varchar2 |
Auto Collection | |||
backup_ |
varchar2 |
Backup Payment Source ID | |||
billing_ |
varchar2 |
Billing Address City | |||
billing_ |
varchar2 |
Billing Address Company | |||
billing_ |
varchar2 |
Billing Address Country | |||
billing_ |
varchar2 |
Billing Address Email | |||
billing_ |
varchar2 |
Billing Address First Name | |||
billing_ |
varchar2 |
Billing Address Last Name | |||
billing_ |
varchar2 |
Billing Address Line 1 | |||
billing_ |
varchar2 |
Billing Address Line 2 | |||
billing_ |
varchar2 |
Billing Address Line 3 | |||
billing_ |
varchar2 |
Billing Address Phone | |||
billing_ |
varchar2 |
Billing Address State | |||
billing_ |
varchar2 |
itgen_cbe_billing_address_state_code | |||
billing_ |
varchar2 |
Billing Address Validation Status | |||
billing_ |
varchar2 |
itgen_cbe_billing_address_zip | |||
billing_ |
int64 |
Billing Date | |||
billing_ |
varchar2 |
Billing Date Mode | |||
billing_ |
varchar2 |
Billing Day of Week | |||
billing_ |
varchar2 |
Billing Day of Week Mode | |||
business_ |
char |
Business Customer Without VAT Number | |||
business_ |
varchar2 |
itgen_cbe_business_entity_id | The unique ID of the business entity of this subscription. This is always the same as the business entity of the customer. | ||
channel |
varchar2 |
itgen_cbe_channel | The subscription channel this object originated from and is maintained in. Possible values are: web, app_store or play_store. | ||
child_ |
varchar2 |
Child Account Access Portal Download Invoices | |||
child_ |
varchar2 |
Child Account Access Portal Edit Subscriptions | |||
child_ |
char |
Child Account Access Send Invoice Emails | |||
child_ |
char |
Child Account Access Send Payment Emails | |||
child_ |
char |
Child Account Access Send Subscription Emails | |||
client_ |
varchar2 |
Client Profile ID | |||
company |
varchar2 |
Company | Company name of the customer. | ||
consolidated_ |
char |
Consolidated Invoicing | |||
created_ |
datetime |
Created at | |||
created_ |
varchar2 |
Created From IP | |||
customer_ |
varchar2 |
Customer Type | |||
deleted |
char |
Deleted | |||
einvoicing_ |
varchar2 |
itgen_cbe_einvoicing_method | Determines whether to send e-invoice manually or automatic. Possible values are: automatic, manual or site_default. | ||
email |
varchar2 |
Email of the customer. Configured email notifications will be sent to this email. | |||
entity_ |
varchar2 |
Entity Code | |||
entity_ |
varchar2 |
itgen_cbe_entity_identifier_scheme | The Peppol BIS scheme associated with the vat_number of the customer. This helps identify the specific type of customer entity. | ||
entity_ |
varchar2 |
itgen_cbe_entity_identifier_standard | 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_ |
decimal |
Excess Payments | |||
exempt_ |
varchar2 |
Exempt Number | |||
first_ |
varchar2 |
First Name | First name of the customer. | ||
fraud_ |
varchar2 |
Fraud Flag | |||
id |
varchar2 |
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_ |
varchar2 |
Invoice Notes | |||
is_ |
char |
itgen_cbe_is_einvoice_enabled | 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_ |
char |
Is Location Valid | |||
last_ |
varchar2 |
Last Name | Last name of the customer. | ||
locale |
varchar2 |
Locale | |||
meta_ |
varchar2 |
Meta Data | |||
net_ |
int32 |
Net Term Days | The number of days within which the customer has to make payment for the invoice. | ||
offline_ |
varchar2 |
Offline Payment Method | |||
parent_ |
varchar2 |
Parent Account Access Portal Download Child Invoices | |||
parent_ |
varchar2 |
Parent Account Access Portal Edit Child Subscriptions | |||
parent_ |
char |
Parent Account Access Send Invoice Emails | |||
parent_ |
char |
Parent Account Access Send Payment Emails | |||
parent_ |
char |
Parent Account Access Send Subscription Emails | |||
payment_ |
varchar2 |
Payment Method Gateway | |||
payment_ |
varchar2 |
Payment Method Gateway Account ID | |||
payment_ |
varchar2 |
Payment Method Reference ID | |||
payment_ |
varchar2 |
Payment Method Status | |||
payment_ |
varchar2 |
Payment Method Type | |||
phone |
varchar2 |
Phone | Phone number of the customer. | ||
pii_ |
varchar2 |
PII Cleared | |||
preferred_ |
varchar2 |
Preferred Currency Code | |||
primary_ |
varchar2 |
Primary Payment Source ID | |||
promotional_ |
decimal |
Promotional Credits | |||
refundable_ |
decimal |
Refundable Credits | |||
registered_ |
char |
Registered For GST | |||
relationship_ |
varchar2 |
Relationship Invoice Owner ID | |||
relationship_ |
varchar2 |
Relationship Parent ID | |||
relationship_ |
varchar2 |
Relationship Payment Owner ID | |||
resource_ |
int64 |
Resource Version | |||
taxability |
varchar2 |
Taxability | |||
unbilled_ |
decimal |
Unbilled Charges | |||
updated_ |
datetime |
Updated at | |||
use_ |
char |
Use Default Hierarchy Settings | |||
vat_ |
varchar2 |
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. | ||
vat_ |
varchar2 |
itgen_cbe_vat_number_prefix | 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_ |
varchar2 |
VAT Number Status | |||
vat_ |
datetime |
VAT Number Validated Time | Returns the recent VAT number validation time. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: