---
title: "Customers (Chargebee)"
description: "Customers"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/chargebee/Chargebee.Customers.Customers
original: https://documentation.invantive.eu/en/datamodels/chargebee/Chargebee.Customers.Customers
updated: 2024-06-10T18:44:26Z
license: https://documentation.invantive.eu/en/
---

# 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_id` | `varchar2(50)` | itgen_cbe_active_id | [ ] |  | Represents the id of the active version of the customer resource. |
| `allow_direct_debit` | `char` | Allow Direct Debit | [ ] |  | Whether the customer can pay via Direct Debit. |
| `auto_close_invoices` | `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_collection` | `varchar2(30)` | Auto Collection | [ ] |  |  |
| `backup_payment_source_id` | `varchar2` | Backup Payment Source ID | [ ] |  |  |
| `billing_address_city` | `varchar2(50)` | Billing Address City | [ ] |  |  |
| `billing_address_company` | `varchar2(250)` | Billing Address Company | [ ] |  |  |
| `billing_address_country` | `varchar2(50)` | Billing Address Country | [ ] |  |  |
| `billing_address_email` | `varchar2(70)` | Billing Address Email | [ ] |  |  |
| `billing_address_first_name` | `varchar2(150)` | Billing Address First Name | [ ] |  |  |
| `billing_address_last_name` | `varchar2(150)` | Billing Address Last Name | [ ] |  |  |
| `billing_address_line1` | `varchar2(150)` | Billing Address Line 1 | [ ] |  |  |
| `billing_address_line2` | `varchar2(150)` | Billing Address Line 2 | [ ] |  |  |
| `billing_address_line3` | `varchar2(150)` | Billing Address Line 3 | [ ] |  |  |
| `billing_address_phone` | `varchar2(50)` | Billing Address Phone | [ ] |  |  |
| `billing_address_state` | `varchar2(50)` | Billing Address State | [ ] |  |  |
| `billing_address_state_code` | `varchar2(50)` | itgen_cbe_billing_address_state_code | [ ] |  |  |
| `billing_address_validation_status` | `varchar2(30)` | Billing Address Validation Status | [ ] |  |  |
| `billing_address_zip` | `varchar2(20)` | itgen_cbe_billing_address_zip | [ ] |  |  |
| `billing_date` | `int64` | Billing Date | [ ] |  |  |
| `billing_date_mode` | `varchar2` | Billing Date Mode | [ ] |  |  |
| `billing_day_of_week` | `varchar2` | Billing Day of Week | [ ] |  |  |
| `billing_day_of_week_mode` | `varchar2` | Billing Day of Week Mode | [ ] |  |  |
| `business_customer_without_vat_number` | `char` | Business Customer Without VAT Number | [ ] |  |  |
| `business_entity_id` | `varchar2(50)` | 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(30)` | itgen_cbe_channel | [ ] |  | 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` | `varchar2` | Child Account Access Portal Download Invoices | [ ] |  |  |
| `child_account_access_portal_edit_subscriptions` | `varchar2` | Child Account Access Portal Edit Subscriptions | [ ] |  |  |
| `child_account_access_send_invoice_emails` | `char` | Child Account Access Send Invoice Emails | [ ] |  |  |
| `child_account_access_send_payment_emails` | `char` | Child Account Access Send Payment Emails | [ ] |  |  |
| `child_account_access_send_subscription_emails` | `char` | Child Account Access Send Subscription Emails | [ ] |  |  |
| `client_profile_id` | `varchar2` | Client Profile ID | [ ] |  |  |
| `company` | `varchar2(250)` | Company | [ ] |  | Company name of the customer. |
| `consolidated_invoicing` | `char` | Consolidated Invoicing | [ ] |  |  |
| `created_at` | `datetime` | Created at | [ ] |  |  |
| `created_from_ip` | `varchar2` | Created From IP | [ ] |  |  |
| `customer_type` | `varchar2` | Customer Type | [ ] |  |  |
| `deleted` | `char` | Deleted | [ ] |  |  |
| `einvoicing_method` | `varchar2(30)` | itgen_cbe_einvoicing_method | [ ] |  | Determines whether to send e-invoice manually or automatic. Possible values are: automatic, manual or site_default. |
| `email` | `varchar2(70)` | Email | [ ] |  | Email of the customer. Configured email notifications will be sent to this email. |
| `entity_code` | `varchar2(30)` | Entity Code | [ ] |  |  |
| `entity_identifier_scheme` | `varchar2(50)` | 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_identifier_standard` | `varchar2(50)` | 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_payments` | `decimal` | Excess Payments | [ ] |  |  |
| `exempt_number` | `varchar2(100)` | Exempt Number | [ ] |  |  |
| `first_name` | `varchar2(150)` | First Name | [ ] |  | First name of the customer. |
| `fraud_flag` | `varchar2` | Fraud Flag | [ ] |  |  |
| `id` | `varchar2(50)` | ID | [x] |  | 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` | `varchar2(2000)` | Invoice Notes | [ ] |  |  |
| `is_einvoice_enabled` | `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_location_valid` | `char` | Is Location Valid | [ ] |  |  |
| `last_name` | `varchar2(150)` | Last Name | [ ] |  | Last name of the customer. |
| `locale` | `varchar2(50)` | Locale | [ ] |  |  |
| `meta_data` | `varchar2` | 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` | `varchar2(30)` | Offline Payment Method | [ ] |  |  |
| `parent_account_access_portal_download_child_invoices` | `varchar2` | Parent Account Access Portal Download Child Invoices | [ ] |  |  |
| `parent_account_access_portal_edit_child_subscriptions` | `varchar2` | Parent Account Access Portal Edit Child Subscriptions | [ ] |  |  |
| `parent_account_access_send_invoice_emails` | `char` | Parent Account Access Send Invoice Emails | [ ] |  |  |
| `parent_account_access_send_payment_emails` | `char` | Parent Account Access Send Payment Emails | [ ] |  |  |
| `parent_account_access_send_subscription_emails` | `char` | Parent Account Access Send Subscription Emails | [ ] |  |  |
| `payment_method_gateway` | `varchar2` | Payment Method Gateway | [ ] |  |  |
| `payment_method_gateway_account_id` | `varchar2` | Payment Method Gateway Account ID | [ ] |  |  |
| `payment_method_reference_id` | `varchar2` | Payment Method Reference ID | [ ] |  |  |
| `payment_method_status` | `varchar2` | Payment Method Status | [ ] |  |  |
| `payment_method_type` | `varchar2` | Payment Method Type | [ ] |  |  |
| `phone` | `varchar2(50)` | Phone | [ ] |  | Phone number of the customer. |
| `pii_cleared` | `varchar2` | PII Cleared | [ ] |  |  |
| `preferred_currency_code` | `varchar2` | Preferred Currency Code | [ ] |  |  |
| `primary_payment_source_id` | `varchar2` | Primary Payment Source ID | [ ] |  |  |
| `promotional_credits` | `decimal` | Promotional Credits | [ ] |  |  |
| `refundable_credits` | `decimal` | Refundable Credits | [ ] |  |  |
| `registered_for_gst` | `char` | Registered For GST | [ ] |  |  |
| `relationship_invoice_owner_id` | `varchar2` | Relationship Invoice Owner ID | [ ] |  |  |
| `relationship_parent_id` | `varchar2` | Relationship Parent ID | [ ] |  |  |
| `relationship_payment_owner_id` | `varchar2` | Relationship Payment Owner ID | [ ] |  |  |
| `resource_version` | `int64` | Resource Version | [ ] |  |  |
| `taxability` | `varchar2(30)` | Taxability | [ ] |  |  |
| `unbilled_charges` | `decimal` | Unbilled Charges | [ ] |  |  |
| `updated_at` | `datetime` | Updated at | [ ] |  |  |
| `use_default_hierarchy_settings` | `char` | Use Default Hierarchy Settings | [ ] |  |  |
| `vat_number` | `varchar2(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. |
| `vat_number_prefix` | `varchar2(10)` | 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_number_status` | `varchar2(30)` | VAT Number Status | [ ] |  |  |
| `vat_number_validated_time` | `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:

- [Chargebee](/en/release-notes/drivers?driver=chargebee)

