# Chargebee (v1)
Information note **Chargebee is supported by the Singer community**
This integration is powered by [Singer's](https://www.singer.io/) Chargebee tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-chargebee) or [join the Singer Slack](https://singer-slackin.herokuapp.com/).
## Chargebee integration summary
Stitch’s Chargebee integration replicates data using the [Chargebee v2 API](https://apidocs.chargebee.com/docs/api) . Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#schema) section for a list of objects available for replication.
This integration supports Chargebee sites that use version 1.0 or version 2.0 of Chargebee’s Product Catalog. The Product Catalog version your site uses determines which tables and fields you can select for replication, however. Refer to the [Table and field availability and Chargebee product catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
## Chargebee feature snapshot
A high-level look at Stitch's Chargebee (v1) integration, including release status, useful links, and the features supported in Stitch.
| **STITCH** | | | |
| --- | --- | --- | --- |
| **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on May 21, 2019 | **Supported by**
the Info icon
Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) |
| **Stitch plan**
the Info icon
The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**
the Info icon
Indicates if the integration is available as a source in Stitch Connect. | the Success icon
This version of the integration is available via the API.
Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon
Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.
The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon
This feature is supported for this version of the integration.
Supported | **Column selection**
the Info icon
The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon
This feature is supported for this version of the integration.
Supported |
| **Select all**
the Info icon
Indicates if the integration supports selecting all available tables and columns. | the Success icon
Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon
This feature is supported for this version of the integration.
Supported |
## Connecting Chargebee
### Step 1: Generate an API Key
First, you’ll generate a Chargebee API Key for Stitch. This will allow Stitch to read data from your Chargebee account using the Chargebee API.
1. Sign into your [Chargebee account](https://app.chargebee.com/login).
2. In the left sidenav, click **Settings > Configure Chargebee**.
3. Click the **API keys and webhooks** button.
4. On the API Keys page, click the **+ Add API Key** button. The **Create an API Key** modal will display.
5. Select **Read-Only Key** as the API key type.
6. Select **All** to define the API key’s access. This will grant read-only access to your Chargebee site.
7. In the **Name the API key** field, enter `Stitch`.
8. Click **Create Key**.
Chargebee will create the API key and redirect you back to the API Keys page:
Copy the API key somwhere handy - you’ll need it to complete the setup in Stitch.
### Step 2: Add Chargebee as a Stitch data source
1. [Sign into your Stitch account](https://app.stitchdata.com/).
2. On the Stitch Dashboard page, click the **Add Integration** button.
3. Click the **Chargebee** icon.
4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Chargebee” would create a schema called `stitch_chargebee` in the destination. **Note**: Schema names cannot be changed after you save the integration.
5. In the **API Key** field, paste the API key you generated in [Step 1](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#generate-api-key).
6. In the **Site** field, enter the name of your Chargebee site. This can be found in the URL of your Chargebee site. For example: If the URL was `https://stitch.chargebee.com`, only `stitch` would be entered into this field.
### Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Chargebee integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Chargebee’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide.
### Step 4: Create a replication schedule
Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.
In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Chargebee integrations support the following replication scheduling methods:
* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)
* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)
* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage.
### Step 5: Set objects to replicate
Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements).
The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#schema)
**Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts.
* Selection options
* Individual tables and columns
* All tables and columns
For Chargebee integrations, you can select:
1. **Individual tables and columns**
2. **All tables and columns**
Click the tabs to view instructions for each selection method.
1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate.
2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate.
3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate.
4. Repeat this process for all the tables and columns you want to replicate.
5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections.
Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature.
1. Click into the integration from the Stitch Dashboard page.
2. Click the **Tables to Replicate** tab.
3. In the list of tables, click the box next to the **Table Names** column.
4. In the menu that displays, click **Track all Tables and Fields**:
The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab
5. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections.
### Initial and historical replication jobs
After you finish setting up Chargebee, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.**
Information note
**Initial replication jobs with Anchor Scheduling**
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information.
#### Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage.
## Chargebee replication
* [Table and field availability and Chargebee product catalogs](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions)
### Table and field availability and Chargebee product catalogs
The availability of some tables and fields is dependent on the Chargebee Product Catalog version your Chargebee site uses. Refer to [Chargebee’s documentation](https://www.chargebee.com/docs/2.0/product-catalog.html) for more info, including how to identify which Product Catalog version your site is using.
The following table contains a list of the tables included in this version of Stitch’s Chargebee integration and the Product Catalog version required to replicate the table.
Additionally, some fields are also subject to Product Catalog version requirements. These fields are noted in the attribute documentation for individual tables.
**Note**: If your site is using a Product Catalog version that a table or field doesn’t support, the table/field won’t display in the **Tables to Replicate** tab in Stitch. For example: If the site is using v2.0 of the Product Catalog, tables/fields that require v1.0 won’t display in Stitch.
| **Table name** | **Required Product Catalog version** |
| --- | --- |
## Chargebee table reference
Information note
**Schemas and versioning**
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for **version 1** of this integration.
This is the latest version of the Chargebee integration.
Information note
**Table and column names in your destination**
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info.
### addons
The `addons` table contains info about the addons in your Chargebee account. Addons are additional charges applied to subscriptions apart from base charges.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [addons schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/plan_model/addons.json "Opens in new tab: addons schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/addons?prod_cat_ver=1#list_addons "Opens in new tab: Chargebee API method") |
addons table foreign keys
| Join addons with | on |
| --- | --- |
| [invoices](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#invoices) | ``` addons.id = invoices.notes.entity_id ``` |
| [plans](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#plans) | ``` addons.id = plans.applicable_addons.id ``` |
addons table schema
| **accounting\_category1**
STRING |
| --- |
| **accounting\_category2**
STRING |
| **accounting\_category3**
STRING |
| **accounting\_category4**
STRING |
| **accounting\_code**
STRING |
| **archived\_at**
DATE-TIME |
| **avalara\_sale\_type**
STRING |
| **avalara\_service\_type**
INTEGER |
| **avalara\_transaction\_type**
INTEGER |
| **channel**
STRING |
| **charge\_type**
STRING |
| **currency\_code**
STRING |
| **custom\_fields**
STRING |
| **description**
STRING |
| **enabled\_in\_portal**
BOOLEAN |
| **id**
STRING |
| **included\_in\_mrr**
BOOLEAN |
| **invoice\_name**
STRING |
| **invoice\_notes**
STRING |
| **is\_shippable**
BOOLEAN |
| **meta\_data**
STRING |
| **name**
STRING |
| **object**
STRING |
| **period**
INTEGER |
| **period\_unit**
STRING |
| **price**
INTEGER |
| **price\_in\_decimal**
STRING |
| **pricing\_model**
STRING |
| **resource\_version**
INTEGER |
| **shipping\_frequency\_period**
INTEGER |
| **shipping\_frequency\_period\_unit**
STRING |
| **show\_description\_in\_invoices**
BOOLEAN |
| **show\_description\_in\_quotes**
BOOLEAN |
| **sku**
STRING |
| **status**
STRING |
| **tax\_code**
STRING |
| **tax\_profile\_id**
STRING |
| **taxable**
BOOLEAN |
| **taxjar\_product\_code**
STRING |
| **tiers**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand tiers
ending_unit
INTEGER
ending_unit_in_decimal
STRING
object
STRING
price
INTEGER
price_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
|
| **type**
STRING |
| **unit**
STRING |
| **updated\_at**
DATE-TIME |
### comments
The `comments` table contains info about comments in your Chargebee account.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | created\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/comments "Opens in new tab: Chargebee documentation")
[comments schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/common/comments.json "Opens in new tab: comments schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/comments#list_comments "Opens in new tab: Chargebee API method") |
comments table schema
| **added\_by**
STRING |
| --- |
| **created\_at**
DATE-TIME |
| **entity\_id**
STRING |
| **entity\_type**
STRING |
| **id**
STRING |
| **notes**
STRING |
| **object**
STRING |
| **type**
STRING |
### coupons
The `coupons` table contains info about the coupons in your Chargebee account.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [coupons schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/item_model/coupons.json "Opens in new tab: coupons schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/coupons#list_coupons "Opens in new tab: Chargebee API method") |
coupons table foreign keys
| Join coupons with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` coupons.id = credit_notes.discounts.entity_id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand item\_constraint\_criteria
currencies
ARRAY
item_family_ids
ARRAY
item_price_periods
ARRAY
item_type
STRING
|
| **item\_constraints**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand item\_constraints
constraint
STRING
item_price_ids
ARRAY
item_type
STRING
|
| **max\_redemptions**
INTEGER |
| **meta\_data**
STRING |
| **name**
STRING |
| **object**
STRING |
| **period**
INTEGER |
| **period\_unit**
STRING |
| **redemptions**
INTEGER |
| **resource\_version**
INTEGER |
| **status**
STRING |
| **updated\_at**
DATE-TIME |
| **valid\_till**
DATE-TIME |
### credit\_notes
The `credit_notes` table contains info about the credit notes in your Chargebee account. A credit note is a document that specifies the money owed by a business to a customer.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/credit_notes "Opens in new tab: Chargebee documentation")
[credit_notes schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/common/credit_notes.json "Opens in new tab: credit_notes schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/credit_notes#list_credit_notes "Opens in new tab: Chargebee API method") |
credit\_notes table foreign keys
| Join credit\_notes with | on |
| --- | --- |
| [coupons](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#coupons) | ``` credit_notes.discounts.entity_id = coupons.id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand allocations
allocated_amount
INTEGER
allocated_at
DATE-TIME
invoice_date
DATE-TIME
invoice_id
STRING
invoice_status
STRING
|
| --- |
| **amount\_allocated**
INTEGER |
| **amount\_available**
INTEGER |
| **amount\_refunded**
INTEGER |
| **base\_currency\_code**
STRING |
| **channel**
STRING |
| **create\_reason\_code**
STRING |
| **currency\_code**
STRING |
| **customer\_id**
STRING |
| **date**
DATE-TIME |
| **deleted**
BOOLEAN |
| **discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand discounts
amount
INTEGER
description
STRING
entity_id
STRING
entity_type
STRING
object
STRING
|
| **einvoice**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand einvoice
id
STRING
message
STRING
status
STRING
|
| **exchange\_rate**
NUMBER |
| **fractional\_correction**
INTEGER |
| **generated\_at**
DATE-TIME |
| **id**
STRING |
| **line\_item\_discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_discounts
coupon_id
STRING
discount_amount
INTEGER
discount_type
STRING
entity_id
STRING
line_item_id
STRING
object
STRING
|
| **line\_item\_taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_taxes
is_non_compliance_tax
BOOLEAN
is_partial_tax_applied
BOOLEAN
line_item_id
STRING
local_currency_code
STRING
tax_amount
INTEGER
tax_amount_in_local_currency
INTEGER
tax_juris_code
STRING
tax_juris_name
STRING
tax_juris_type
STRING
tax_name
STRING
tax_rate
NUMBER
taxable_amount
INTEGER
|
| **line\_item\_tiers**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_tiers
ending_unit
INTEGER
ending_unit_in_decimal
STRING
line_item_id
STRING
quantity_used
INTEGER
quantity_used_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
unit_amount
INTEGER
unit_amount_in_decimal
STRING
|
| **line\_items**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_items
amount
INTEGER
amount_in_decimal
STRING
customer_id
STRING
date_from
DATE-TIME
date_to
DATE-TIME
description
STRING
discount_amount
INTEGER
entity_description
STRING
entity_id
STRING
entity_type
STRING
id
STRING
is_taxed
BOOLEAN
item_level_discount_amount
INTEGER
object
STRING
pricing_model
STRING
quantity
INTEGER
quantity_in_decimal
STRING
subscription_id
STRING
tax_amount
INTEGER
tax_exempt_reason
STRING
tax_rate
NUMBER
unit_amount
INTEGER
unit_amount_in_decimal
STRING
|
| **linked\_refunds**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand linked\_refunds
applied_amount
INTEGER
applied_at
DATE-TIME
refund_reason_code
STRING
txn_amount
INTEGER
txn_date
DATE-TIME
txn_id
STRING
txn_status
STRING
|
| **local\_currency\_code**
STRING |
| **object**
STRING |
| **price\_type**
STRING |
| **reason\_code**
STRING |
| **reference\_invoice\_id**
STRING |
| **refunded\_at**
DATE-TIME |
| **resource\_version**
INTEGER |
| **round\_off\_amount**
INTEGER |
| **status**
STRING |
| **sub\_total**
INTEGER |
| **sub\_total\_in\_local\_currency**
INTEGER |
| **subscription\_id**
STRING |
| **taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand taxes
amount
INTEGER
description
STRING
name
STRING
|
| **total**
INTEGER |
| **total\_in\_local\_currency**
INTEGER |
| **type**
STRING |
| **updated\_at**
DATE-TIME |
| **vat\_number**
STRING |
| **vat\_number\_prefix**
STRING |
| **voided\_at**
DATE-TIME |
### customers
The `customers` table contains info about the customers in your Chargebee account.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/customers "Opens in new tab: Chargebee documentation")
[customers schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/customers.json "Opens in new tab: customers schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/customers#list_customers "Opens in new tab: Chargebee API method") |
customers table foreign keys
| Join customers with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` customers.id = credit_notes.customer_id ``` |
| [events](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#events) | ``` customers.id = events.content.customer.id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand balances
balance_currency_code
STRING
currency_code
STRING
excess_payments
INTEGER
object
STRING
promotional_credits
INTEGER
refundable_credits
INTEGER
unbilled_charges
INTEGER
|
| **billing\_address**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand child\_account\_access
portal_download_invoices
STRING
portal_edit_subscriptions
STRING
send_invoice_emails
BOOLEAN
send_payment_emails
BOOLEAN
send_subscription_emails
BOOLEAN
|
| **client\_profile\_id**
STRING |
| **company**
STRING |
| **consolidated\_invoicing**
BOOLEAN |
| **contacts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand contacts
email
STRING
enabled
BOOLEAN
first_name
STRING
id
STRING
label
STRING
last_name
STRING
object
STRING
phone
STRING
send_account_email
STRING
send_billing_email
STRING
|
| **created\_at**
DATE-TIME |
| **created\_from\_ip**
STRING |
| **custom\_fields**
STRING |
| **customer\_type**
STRING |
| **deleted**
BOOLEAN |
| **email**
STRING |
| **entity\_code**
STRING |
| **entity\_identifier\_scheme**
STRING |
| **entity\_identifier\_standard**
STRING |
| **entity\_identifiers**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand entity\_identifiers
id
STRING
scheme
STRING
standard
STRING
value
STRING
|
| **excess\_payments**
INTEGER |
| **exempt\_number**
STRING |
| **exemption\_details**
STRING |
| **first\_name**
STRING |
| **fraud\_flag**
STRING |
| **id**
STRING |
| **invoice\_notes**
STRING |
| **is\_einvoice\_enabled**
BOOLEAN |
| **is\_location\_valid**
BOOLEAN |
| **last\_name**
STRING |
| **locale**
STRING |
| **meta\_data**
STRING |
| **mrr**
INTEGER |
| **net\_term\_days**
INTEGER |
| **object**
STRING |
| **offline\_payment\_method**
STRING |
| **parent\_account\_access**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand parent\_account\_access
portal_download_child_invoices
STRING
portal_edit_child_subscriptions
STRING
send_invoice_emails
BOOLEAN
send_payment_emails
BOOLEAN
send_subscription_emails
BOOLEAN
|
| **payment\_method**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand payment\_method
gateway
STRING
gateway_account_id
STRING
object
STRING
reference_id
STRING
status
STRING
type
STRING
|
| **phone**
STRING |
| **pii\_cleared**
STRING |
| **preferred\_currency\_code**
STRING |
| **primary\_payment\_source\_id**
STRING |
| **promotional\_credits**
INTEGER |
| **referral\_urls**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand referral\_urls
created_at
DATE-TIME
external_customer_id
STRING
referral_account_id
STRING
referral_campaign_id
STRING
referral_external_account_id
STRING
referral_sharing_url
STRING
referral_system
STRING
updated_at
DATE-TIME
|
| **refundable\_credits**
INTEGER |
| **registered\_for\_gst**
BOOLEAN |
| **relationship**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
DATE-TIME |
### events
The `events` table contains info about the events that have occurred on your Chargebee site. Event records contain data about affected resources and additional details, such as when the change occurred. This can be used to create a log of events for a record and analyze how it has changed over time.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | occurred\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/events "Opens in new tab: Chargebee documentation")
[events schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/events.json "Opens in new tab: events schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/events#list_events "Opens in new tab: Chargebee API method") |
events table foreign keys
| Join events with | on |
| --- | --- |
| [coupons](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#coupons) | ``` events.content.coupon.id = coupons.id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand content
coupon
OBJECT
apply_discount_on
STRING
apply_on
STRING
archived_at
DATE-TIME
created_at
DATE-TIME
currency_code
STRING
discount_amount
NUMBER
discount_percentage
NUMBER
discount_type
STRING
duration_month
INTEGER
duration_type
STRING
id
STRING
invoice_name
STRING
invoice_notes
STRING
item_constraint_criteria
ARRAY
currencies
ARRAY
item_family_ids
ARRAY
item_price_periods
ARRAY
item_type
STRING
item_constraints
ARRAY
constraint
STRING
item_price_ids
ARRAY
item_type
STRING
max_redemptions
INTEGER
meta_data
STRING
name
STRING
object
STRING
period
INTEGER
period_unit
STRING
redemptions
INTEGER
resource_version
INTEGER
status
STRING
updated_at
DATE-TIME
valid_till
DATE-TIME
coupon_code
OBJECT
code
STRING
coupon_id
STRING
coupon_set_id
STRING
coupon_set_name
STRING
coupon_site_id
STRING
status
STRING
coupon_set
OBJECT
archived_count
INTEGER
coupon_id
STRING
id
STRING
meta_data
STRING
name
STRING
redeemed_count
INTEGER
total_count
INTEGER
credit_note
OBJECT
allocations
ARRAY
allocated_amount
INTEGER
allocated_at
DATE-TIME
invoice_date
DATE-TIME
invoice_id
STRING
invoice_status
STRING
amount_allocated
INTEGER
amount_available
INTEGER
amount_refunded
INTEGER
base_currency_code
STRING
channel
STRING
create_reason_code
STRING
currency_code
STRING
customer_id
STRING
date
DATE-TIME
deleted
BOOLEAN
discounts
ARRAY
amount
INTEGER
description
STRING
entity_id
STRING
entity_type
STRING
object
STRING
einvoice
OBJECT
id
STRING
message
STRING
status
STRING
exchange_rate
NUMBER
fractional_correction
INTEGER
generated_at
DATE-TIME
id
STRING
line_item_discounts
ARRAY
coupon_id
STRING
discount_amount
INTEGER
discount_type
STRING
entity_id
STRING
line_item_id
STRING
object
STRING
line_item_taxes
ARRAY
is_non_compliance_tax
BOOLEAN
is_partial_tax_applied
BOOLEAN
line_item_id
STRING
local_currency_code
STRING
tax_amount
INTEGER
tax_amount_in_local_currency
INTEGER
tax_juris_code
STRING
tax_juris_name
STRING
tax_juris_type
STRING
tax_name
STRING
tax_rate
NUMBER
taxable_amount
INTEGER
line_item_tiers
ARRAY
ending_unit
INTEGER
ending_unit_in_decimal
STRING
line_item_id
STRING
quantity_used
INTEGER
quantity_used_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
unit_amount
INTEGER
unit_amount_in_decimal
STRING
line_items
ARRAY
amount
INTEGER
amount_in_decimal
STRING
customer_id
STRING
date_from
DATE-TIME
date_to
DATE-TIME
description
STRING
discount_amount
INTEGER
entity_description
STRING
entity_id
STRING
entity_type
STRING
id
STRING
is_taxed
BOOLEAN
item_level_discount_amount
INTEGER
object
STRING
pricing_model
STRING
quantity
INTEGER
quantity_in_decimal
STRING
subscription_id
STRING
tax_amount
INTEGER
tax_exempt_reason
STRING
tax_rate
NUMBER
unit_amount
INTEGER
unit_amount_in_decimal
STRING
linked_refunds
ARRAY
applied_amount
INTEGER
applied_at
DATE-TIME
refund_reason_code
STRING
txn_amount
INTEGER
txn_date
DATE-TIME
txn_id
STRING
txn_status
STRING
local_currency_code
STRING
object
STRING
price_type
STRING
reason_code
STRING
reference_invoice_id
STRING
refunded_at
DATE-TIME
resource_version
INTEGER
round_off_amount
INTEGER
status
STRING
sub_total
INTEGER
sub_total_in_local_currency
INTEGER
subscription_id
STRING
taxes
ARRAY
amount
INTEGER
description
STRING
name
STRING
total
INTEGER
total_in_local_currency
INTEGER
type
STRING
updated_at
DATE-TIME
vat_number
STRING
vat_number_prefix
STRING
voided_at
DATE-TIME
customer
OBJECT
allow_direct_debit
BOOLEAN
auto_close_invoices
BOOLEAN
auto_collection
STRING
backup_payment_source_id
STRING
balances
ARRAY
balance_currency_code
STRING
currency_code
STRING
excess_payments
INTEGER
object
STRING
promotional_credits
INTEGER
refundable_credits
INTEGER
unbilled_charges
INTEGER
billing_address
OBJECT
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
billing_date
BOOLEAN
billing_date_mode
STRING
billing_day_of_week
BOOLEAN
billing_day_of_week_mode
STRING
business_customer_without_vat_number
BOOLEAN
business_entity_id
STRING
card_status
STRING
cf_company_id
INTEGER, STRING
cf_people_id
STRING
channel
STRING
child_account_access
OBJECT
portal_download_invoices
STRING
portal_edit_subscriptions
STRING
send_invoice_emails
BOOLEAN
send_payment_emails
BOOLEAN
send_subscription_emails
BOOLEAN
client_profile_id
STRING
company
STRING
consolidated_invoicing
BOOLEAN
contacts
ARRAY
email
STRING
enabled
BOOLEAN
first_name
STRING
id
STRING
label
STRING
last_name
STRING
object
STRING
phone
STRING
send_account_email
STRING
send_billing_email
STRING
created_at
DATE-TIME
created_from_ip
STRING
custom_fields
STRING
customer_type
STRING
deleted
BOOLEAN
email
STRING
entity_code
STRING
entity_identifier_scheme
STRING
entity_identifier_standard
STRING
entity_identifiers
ARRAY
id
STRING
scheme
STRING
standard
STRING
value
STRING
excess_payments
INTEGER
exempt_number
STRING
exemption_details
STRING
first_name
STRING
fraud_flag
STRING
id
STRING
invoice_notes
STRING
is_einvoice_enabled
BOOLEAN
is_location_valid
BOOLEAN
last_name
STRING
locale
STRING
meta_data
STRING
mrr
INTEGER
net_term_days
INTEGER
object
STRING
offline_payment_method
STRING
parent_account_access
OBJECT
portal_download_child_invoices
STRING
portal_edit_child_subscriptions
STRING
send_invoice_emails
BOOLEAN
send_payment_emails
BOOLEAN
send_subscription_emails
BOOLEAN
payment_method
OBJECT
gateway
STRING
gateway_account_id
STRING
object
STRING
reference_id
STRING
status
STRING
type
STRING
phone
STRING
pii_cleared
STRING
preferred_currency_code
STRING
primary_payment_source_id
STRING
promotional_credits
INTEGER
referral_urls
ARRAY
created_at
DATE-TIME
external_customer_id
STRING
referral_account_id
STRING
referral_campaign_id
STRING
referral_external_account_id
STRING
referral_sharing_url
STRING
referral_system
STRING
updated_at
DATE-TIME
refundable_credits
INTEGER
registered_for_gst
BOOLEAN
relationship
OBJECT
invoice_owner_id
STRING
parent_id
STRING
payment_owner_id
STRING
root_id
STRING
resource_version
INTEGER
tax_providers_fields
STRING
taxability
STRING
unbilled_charges
INTEGER
updated_at
DATE-TIME
use_default_hierarchy_settings
BOOLEAN
vat_number
STRING
vat_number_prefix
STRING
vat_number_status
STRING
vat_number_validated_time
DATE-TIME
gift
OBJECT
auto_claim
BOOLEAN
claim_expiry_date
DATE-TIME
gift_receiver
OBJECT
customer_id
STRING
email
STRING
first_name
STRING
last_name
STRING
subscription_id
STRING
gift_timelines
ARRAY
occurred_at
DATE-TIME
status
STRING
gifter
OBJECT
customer_id
STRING
invoice_id
STRING
note
STRING
signature
STRING
id
STRING
no_expiry
BOOLEAN
resource_version
INTEGER
scheduled_at
DATE-TIME
status
STRING
updated_at
DATE-TIME
invoice
OBJECT
adjustment_credit_notes
ARRAY
cn_create_reason_code
STRING
cn_date
DATE-TIME
cn_id
STRING
cn_reason_code
STRING
cn_status
STRING
cn_total
INTEGER
amount_adjusted
INTEGER
amount_due
INTEGER
amount_paid
INTEGER
amount_to_collect
INTEGER
applied_credits
ARRAY
applied_amount
INTEGER
applied_at
DATE-TIME
cn_create_reason_code
STRING
cn_date
DATE-TIME
cn_id
STRING
cn_reason_code
STRING
cn_status
STRING
base_currency_code
STRING
billing_address
OBJECT
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
channel
STRING
credits_applied
INTEGER
currency_code
STRING
customer_id
STRING
date
DATE-TIME
deleted
BOOLEAN
discounts
ARRAY
amount
INTEGER
description
STRING
entity_id
STRING
entity_type
STRING
object
STRING
due_date
DATE-TIME
dunning_attempts
ARRAY
attempt
INTEGER
created_at
DATE-TIME
dunning_type
STRING
transaction_id
STRING
txn_amount
INTEGER
txn_status
STRING
dunning_status
STRING
einvoice
OBJECT
id
STRING
message
STRING
status
STRING
exchange_rate
NUMBER
expected_payment_date
DATE-TIME
first_invoice
BOOLEAN
generated_at
DATE-TIME
has_advance_charges
BOOLEAN
id
STRING
is_gifted
BOOLEAN
issued_credit_notes
ARRAY
cn_create_reason_code
STRING
cn_date
DATE-TIME
cn_id
STRING
cn_reason_code
STRING
cn_status
STRING
cn_total
INTEGER
line_item_discounts
ARRAY
coupon_id
STRING
discount_amount
INTEGER
discount_type
STRING
entity_id
STRING
line_item_id
STRING
object
STRING
line_item_taxes
ARRAY
is_non_compliance_tax
BOOLEAN
is_partial_tax_applied
BOOLEAN
line_item_id
STRING
local_currency_code
STRING
tax_amount
INTEGER
tax_amount_in_local_currency
INTEGER
tax_juris_code
STRING
tax_juris_name
STRING
tax_juris_type
STRING
tax_name
STRING
tax_rate
INTEGER, NUMBER
taxable_amount
INTEGER
line_item_tiers
ARRAY
ending_unit
INTEGER
ending_unit_in_decimal
STRING
line_item_id
STRING
quantity_used
INTEGER
quantity_used_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
unit_amount
INTEGER
unit_amount_in_decimal
STRING
line_items
ARRAY
amount
INTEGER
amount_in_decimal
STRING
customer_id
STRING
date_from
DATE-TIME
date_to
DATE-TIME
description
STRING
discount_amount
INTEGER
entity_description
STRING
entity_id
STRING
entity_type
STRING
id
STRING
is_taxed
BOOLEAN
item_level_discount_amount
INTEGER
object
STRING
pricing_model
STRING
quantity
INTEGER
quantity_in_decimal
STRING
subscription_id
STRING
tax_amount
INTEGER
tax_exempt_reason
STRING
tax_rate
NUMBER
unit_amount
INTEGER
unit_amount_in_decimal
STRING
linked_orders
ARRAY
batch_id
STRING
created_at
DATE-TIME
document_number
STRING
fulfillment_status
STRING
id
STRING
order_type
STRING
reference_id
STRING
status
STRING
linked_payments
ARRAY
applied_amount
INTEGER
applied_at
DATE-TIME
txn_amount
INTEGER
txn_date
DATE-TIME
txn_id
STRING
txn_status
STRING
local_currency_code
STRING
net_term_days
INTEGER
new_sales_amount
INTEGER
next_retry_at
DATE-TIME
notes
ARRAY
entity_id
STRING
entity_type
STRING
note
STRING
object
STRING
paid_at
DATE-TIME
payment_owner
STRING
po_number
STRING
price_type
STRING
recurring
BOOLEAN
resource_version
INTEGER
round_off_amount
INTEGER
shipping_address
OBJECT
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
status
STRING
sub_total
INTEGER
sub_total_in_local_currency
INTEGER
subscription_id
STRING
tax
INTEGER
taxes
ARRAY
amount
INTEGER
description
STRING
name
STRING
term_finalized
BOOLEAN
total
INTEGER
total_in_local_currency
INTEGER
updated_at
DATE-TIME
vat_number
STRING
vat_number_prefix
STRING
void_reason_code
STRING
voided_at
DATE-TIME
write_off_amount
INTEGER
item
OBJECT
applicable_items
ARRAY
id
STRING
archivable
BOOLEAN, STRING
archived_at
DATE-TIME
channel
STRING
custom_fields
STRING
description
STRING
enabled_for_checkout
BOOLEAN
enabled_in_portal
BOOLEAN
external_name
STRING
gift_claim_redirect_url
STRING
id
STRING
included_in_mrr
BOOLEAN
is_giftable
BOOLEAN
is_shippable
BOOLEAN
item_applicability
STRING
item_family_id
STRING
metadata
STRING
metered
BOOLEAN
name
STRING
object
STRING
redirect_url
STRING
resource_version
INTEGER
status
STRING
type
STRING
unit
STRING
updated_at
DATE-TIME
usage_calculation
STRING
item_family
OBJECT
channel
STRING
custom_fields
STRING
description
STRING
id
STRING
name
STRING
object
STRING
resource_version
INTEGER
status
STRING
updated_at
DATE-TIME
item_price
OBJECT
accounting_detail
OBJECT
accounting_category1
STRING
accounting_category2
STRING
accounting_category3
STRING
accounting_category4
STRING
accounting_code
STRING
sku
STRING
archivable
BOOLEAN, STRING
archived_at
DATE-TIME
billing_cycles
INTEGER
channel
STRING
created_at
DATE-TIME
currency_code
STRING
custom_fields
STRING
description
STRING
external_name
STRING
free_quantity
INTEGER
free_quantity_in_decimal
STRING
id
STRING
invoice_notes
STRING
is_taxable
BOOLEAN
item_family_id
STRING
item_id
STRING
item_type
STRING
metadata
STRING
name
STRING
object
STRING
period
INTEGER
period_unit
STRING
price
INTEGER
price_in_decimal
STRING
pricing_model
STRING
resource_version
INTEGER
shipping_period
INTEGER
shipping_period_unit
STRING
show_description_in_invoices
BOOLEAN
show_description_in_quotes
BOOLEAN
status
STRING
tax_detail
OBJECT
avalara_sale_type
STRING
avalara_service_type
INTEGER
avalara_tax_code
STRING
avalara_transaction_type
INTEGER
tax_profile_id
STRING
taxjar_product_code
STRING
tiers
ARRAY
ending_unit
INTEGER
price
INTEGER
starting_unit
INTEGER
trial_end_action
STRING
trial_period
INTEGER
trial_period_unit
STRING
updated_at
DATE-TIME
order
OBJECT
amount_adjusted
INTEGER
amount_paid
INTEGER
batch_id
STRING
billing_address
OBJECT
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
cancellation_reason
STRING
cancelled_at
DATE-TIME
created_at
DATE-TIME
created_by
STRING
currency_code
STRING
customer_id
STRING
deleted
BOOLEAN
delivered_at
DATE-TIME
discount
INTEGER
document_number
STRING
fulfillment_status
STRING
gift_id
STRING
gift_note
STRING
id
STRING
invoice_id
STRING
invoice_round_off_amount
INTEGER
is_gifted
BOOLEAN
is_resent
BOOLEAN
line_item_discounts
ARRAY
coupon_id
STRING
discount_amount
INTEGER
discount_type
STRING
line_item_id
STRING
line_item_taxes
ARRAY
is_non_compliance_tax
BOOLEAN
is_partial_tax_applied
BOOLEAN
line_item_id
STRING
local_currency_code
STRING
tax_amount
INTEGER
tax_amount_in_local_currency
INTEGER
tax_juris_code
STRING
tax_juris_name
STRING
tax_juris_type
STRING
tax_name
STRING
tax_rate
INTEGER, NUMBER
taxable_amount
INTEGER
linked_credit_notes
ARRAY
amount
INTEGER
amount_adjusted
INTEGER
amount_refunded
INTEGER
id
STRING
status
STRING
type
STRING
note
STRING
order_date
DATE-TIME
order_line_items
ARRAY
amount
INTEGER
amount_adjusted
INTEGER
amount_paid
INTEGER
description
STRING
discount_amount
INTEGER
entity_id
STRING
entity_type
STRING
fulfillment_amount
INTEGER
fulfillment_quantity
INTEGER
id
STRING
invoice_id
STRING
invoice_line_item_id
STRING
is_shippable
BOOLEAN
item_level_discount_amount
INTEGER
refundable_credits
INTEGER
refundable_credits_issued
INTEGER
sku
STRING
status
STRING
tax_amount
INTEGER
unit_price
INTEGER
order_type
STRING
original_order_id
STRING
paid_on
DATE-TIME
payment_status
STRING
price_type
STRING
reference_id
STRING
refundable_credits
INTEGER
refundable_credits_issued
INTEGER
resend_reason
STRING
resent_orders
ARRAY
amount
INTEGER
order_id
STRING
reason
STRING
resent_status
STRING
resource_version
INTEGER
rounding_adjustement
INTEGER
shipment_carrier
STRING
shipped_at
DATE-TIME
shipping_address
OBJECT
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status,
STRING
zip
STRING
shipping_cut_off_date
DATE-TIME
shipping_date
DATE-TIME
status
STRING
status_update_at
DATE-TIME
sub_total
INTEGER
subscription_id
STRING
tax
INTEGER
total
INTEGER
tracking_id
STRING
tracking_url
STRING
updated_at
DATE-TIME
payment_source
OBJECT
amazon_payment
OBJECT
agreement_id
STRING
email
STRING
bank_account
OBJECT
account_holder_type
STRING
account_type
STRING
bank_name
STRING
echeck_type
STRING
last4
STRING
mandate_id
STRING
name_on_account
STRING
card
OBJECT
billing_addr1
STRING
billing_addr2
STRING
billing_city
STRING
billing_country
STRING
billing_state
STRING
billing_state_code
STRING
billing_zip
STRING
brand
STRING
expiry_month
INTEGER
expiry_year
INTEGER
first_name
STRING
funding_type
STRING
iin
STRING
last4
STRING
last_name
STRING
masked_number
STRING
object
STRING
created_at
DATE-TIME
customer_id
STRING
deleted
BOOLEAN
gateway
STRING
gateway_account_id
STRING
id
STRING
ip_address
STRING
issuing_country
STRING
mandates
ARRAY
created_at
DATE-TIME
id
STRING
subscription_id
STRING
object
STRING
paypal
OBJECT
agremeent_id
STRING
email
STRING
reference_id
STRING
resource_version
INTEGER
status
STRING
type
STRING
updated_at
DATE-TIME
upi
OBJECT
vpa
STRING
promotional_credit
OBJECT
amount
STRING
amount_in_decimal
STRING
closing_balance
INTEGER
created_at
DATE-TIME
credit_type
STRING
currency_code
STRING
customer_id
STRING
description
STRING
done_by
STRING
id
STRING
object
STRING
reference
STRING
type
STRING
quote
OBJECT
amount_due
INTEGER
amount_paid
INTEGER
billing_address
OBJECT
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
charge_on_acceptance
INTEGER
contract_term_end
DATE-TIME
contract_term_start
DATE-TIME
contract_term_termination_fee
INTEGER
credits_applied
INTEGER
currency_code
STRING
customer_id
STRING
date
DATE-TIME
discounts
ARRAY
amount
INTEGER
description
STRING
entity_id
STRING
entity_type
STRING
id
STRING
invoice_id
STRING
line_item_discounts
ARRAY
coupon_id
STRING
discount_amount
INTEGER
discount_type
STRING
entity_id
STRING
line_item_id
STRING
line_item_taxes
ARRAY
is_non_compliance_tax
BOOLEAN
is_partial_tax_applied
BOOLEAN
line_item_id
STRING
local_currency_code
STRING
tax_amount
INTEGER
tax_amount_in_local_currency
INTEGER
tax_juris_code
STRING
tax_juris_name
STRING
tax_juris_type
STRING
tax_name
STRING
tax_rate
NUMBER
taxable_amount
INTEGER
line_item_tiers
ARRAY
ending_unit
INTEGER
ending_unit_in_decimal
STRING
line_item_id
STRING
quantity_used
INTEGER
quantity_used_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
unit_amount
INTEGER
unit_amount_in_decimal
STRING
line_items
ARRAY
amount
INTEGER
amount_in_decimal
STRING
customer_id
STRING
date_from
DATE-TIME
date_to
DATE-TIME
description
STRING
discount_amount
INTEGER
entity_description
STRING
entity_id
STRING
entity_type
STRING
id
STRING
is_taxed
BOOLEAN
item_level_discount_amount
INTEGER
object
STRING
pricing_model
STRING
quantity
INTEGER
quantity_in_decimal
STRING
subscription_id
STRING
tax_amount
INTEGER
tax_exempt_reason
STRING
tax_rate
NUMBER
unit_amount
INTEGER
unit_amount_in_decimal
STRING
name
STRING
notes
ARRAY
object
STRING
operation_type
STRING
po_number
STRING
price_type
STRING
resource_version
INTEGER
shipping_address
OBJECT
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status,
STRING
zip
STRING
status
STRING
sub_total
INTEGER
subscription_id
STRING
taxes
ARRAY
amount
INTEGER
description
STRING
name
STRING
total
INTEGER
total_payable
INTEGER
updated_at
DATE-TIME
valid_till
DATE-TIME
vat_number
STRING
vat_number_prefix
STRING
version
INTEGER
subscription
OBJECT
activated_at
DATE-TIME
auto_close_invoices
BOOLEAN
auto_collection
STRING
base_currency_code
STRING
billing_period
INTEGER
billing_period_unit
STRING
cancel_reason
STRING
cancel_reason_code
STRING
cancel_schedule_created_at
DATE-TIME
cancelled_at
DATE-TIME
changes_scheduled_at
DATE-TIME
channel
STRING
charged_items
ARRAY
item_price_id
STRING
last_charged_at
DATE-TIME
object
STRING
contract_term
OBJECT
action_at_term_end
STRING
billing_cycle
INTEGER
cancellation_cutoff_period
INTEGER
contract_end
DATE-TIME
contract_start
DATE-TIME
created_at
DATE-TIME
id
STRING
remaining_billing_cycles
INTEGER
status
STRING
subscription_id
STRING
total_contract_value
INTEGER
contract_term_billing_cycle_on_renewal
INTEGER
coupon
STRING
coupons
ARRAY
applied_count
INTEGER
apply_till
DATE-TIME
coupon_code
STRING
coupon_id
STRING
object
STRING
create_pending_invoices
BOOLEAN
created_at
DATE-TIME
created_from_ip
STRING
currency_code
STRING
current_term_end
DATE-TIME
current_term_start
DATE-TIME
custom_fields
STRING
customer_id
STRING
deleted
BOOLEAN
discounts
ARRAY
amount
NUMBER
applied_count
INTEGER
apply_on
STRING
apply_till
INTEGER
coupon_id
STRING
created_at
INTEGER
currency_code
STRING
duration_type
STRING
id
STRING
included_in_mrr
BOOLEAN
index
INTEGER
invoice_name
STRING
item_price_id
STRING
name
STRING
object
STRING
percentage
NUMBER
period
INTEGER
period_unit
STRING
resource_version
INTEGER
type
STRING
updated_at
INTEGER
due_invoices_count
INTEGER
due_since
DATE-TIME
exchange_rate
NUMBER
free_period
INTEGER
free_period_unit
STRING
has_scheduled_advance_invoices
BOOLEAN
has_scheduled_changes
BOOLEAN
id
STRING
invoice_notes
STRING
item_tiers
ARRAY
ending_unit
INTEGER
ending_unit_in_decimal
STRING
item_price_id
STRING
price
INTEGER
price_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
meta_data
STRING
mrr
INTEGER
next_billing_at
DATE-TIME
object
STRING
override_relationship
BOOLEAN
pause_date
DATE-TIME
payment_source_id
STRING
plan_amount_in_decimal
STRING
plan_free_quantity_in_decimal
STRING
plan_quantity_in_decimal
STRING
plan_unit_price_in_decimal
STRING
po_number
STRING
referral_info
OBJECT
account_id
STRING
campaign_id
STRING
coupon_code
STRING
destination_url
STRING
external_campaign_id
STRING
external_reference_id
STRING
friend_offer_type
STRING
notify_referral_system
STRING
post_purchase_widget_enabled
BOOLEAN
referral_code
STRING
referral_system
STRING
referrer_id
STRING
referrer_reward_type
STRING
reward_status
STRING
remaining_billing_cycles
INTEGER
resource_version
INTEGER
resume_date
DATE-TIME
shipping_address
OBJECT
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
start_date
DATE-TIME
started_at
DATE-TIME
status
STRING
subscription_items
ARRAY
amount
INTEGER
amount_in_decimal
STRING
billing_cycles
INTEGER
charge_on_event
STRING
charge_on_option
STRING
charge_once
BOOLEAN
free_quantity
INTEGER
free_quantity_in_decimal
STRING
item_price_id
STRING
item_type
STRING
object
STRING
quantity
INTEGER
quantity_in_decimal
STRING
service_period_days
INTEGER
trial_end
DATE-TIME
unit_price
INTEGER
unit_price_in_decimal
STRING
total_dues
INTEGER
trial_end
DATE-TIME
trial_end_action
STRING
trial_start
DATE-TIME
updated_at
DATE-TIME
transaction
OBJECT
amount
INTEGER
amount_capturable
STRING
amount_unused
INTEGER
authorization_reason
STRING
base_currency_code
STRING
currency_code
STRING
customer_id
STRING
date
DATE-TIME
deleted
BOOLEAN
error_code
STRING
error_text
STRING
exchange_rate
NUMBER
fraud_flag
STRING
fraud_reason
STRING
gateway
STRING
gateway_account_id
STRING
id
STRING
id_at_gateway
STRING
iin
STRING
initiator_type
STRING
last4
STRING
linked_credit_notes
ARRAY
applied_amount
INTEGER
applied_at
DATE-TIME
cn_create_reason_code
STRING
cn_date
DATE-TIME
cn_id
STRING
cn_reason_code
STRING
cn_reference_invoice_id
STRING
cn_status
STRING
cn_total
INTEGER
linked_invoices
ARRAY
applied_amount
INTEGER
applied_at
DATE-TIME
invoice_date
DATE-TIME
invoice_id
STRING
invoice_status
STRING
invoice_total
INTEGER
linked_payments
ARRAY
amount
INTEGER
date
DATE-TIME
id
STRING
status
STRING
linked_refunds
ARRAY
txn_amount
INTEGER
txn_date
DATE-TIME
txn_id
STRING
txn_status
STRING
masked_card_number
STRING
merchant_reference_id
STRING
object
STRING
payment_method
STRING
payment_source_id
STRING
reference_authorization_id
STRING
reference_number
STRING
reference_transaction_id
STRING
refunded_txn_id
STRING
resource_version
INTEGER
reversal_transaction_id
STRING
reversal_txn_id
STRING
settled_at
DATE-TIME
status
STRING
subscription_id
STRING
three_d_secure
BOOLEAN
type
STRING
updated_at
DATE-TIME
validated_at
DATE-TIME
voided_at
DATE-TIME
unbilled_charges
ARRAY
amount
INTEGER
amount_in_decimal
STRING
currency_code
STRING
customer_id
STRING
date_from
DATE-TIME
date_to
DATE-TIME
deleted
BOOLEAN
description
STRING
discount_amount
INTEGER
entity_id
STRING
entity_type
STRING
id
STRING
is_voided
BOOLEAN
pricing_model
STRING
quantity
INTEGER
quantity_in_decimal
STRING
subscription_id
STRING
tiers
ARRAY
ending_unit
INTEGER
ending_unit_in_decimal
STRING
quantity_used
INTEGER
quantity_used_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
unit_amount
INTEGER
unit_amount_in_decimal
STRING
unit_amount
INTEGER
unit_amount_in_decimal
STRING
voided_at
DATE-TIME
virtual_bank_account
OBJECT
account_number
STRING
bank_name
STRING
created_at
DATE-TIME
customer_id
STRING
deleted
BOOLEAN
email
STRING
gateway
STRING
gateway_account_id
STRING
id
STRING
object
STRING
reference_id
STRING
resource_version
INTEGER
routing_number
STRING
scheme
STRING
swift_code
STRING
updated_at
DATE-TIME
|
| **event\_type**
STRING |
| **id**
STRING |
| **object**
STRING |
| **occurred\_at**
DATE-TIME |
| **source**
STRING |
| **user**
STRING |
| **webhook\_status**
STRING |
### gifts
The `gifts` table contains info about the gifts in your Chargebee account.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/gifts "Opens in new tab: Chargebee documentation")
[gifts schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/gifts.json "Opens in new tab: gifts schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/gifts#list_gifts "Opens in new tab: Chargebee API method") |
gifts table foreign keys
| Join gifts with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` gifts.gift_receiver.customer_id = credit_notes.customer_id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand gift\_receiver
customer_id
STRING
email
STRING
first_name
STRING
last_name
STRING
subscription_id
STRING
|
| **gift\_timelines**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand gift\_timelines
occurred_at
DATE-TIME
status
STRING
|
| **gifter**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand gifter
customer_id
STRING
invoice_id
STRING
note
STRING
signature
STRING
|
| **id**
STRING |
| **no\_expiry**
BOOLEAN |
| **resource\_version**
INTEGER |
| **scheduled\_at**
DATE-TIME |
| **status**
STRING |
| **updated\_at**
DATE-TIME |
### invoices
The `invoices` table contains info about the invoices in your Chargebee account. Invoices are statements containing charges, adjustments, and any discounts for a subscription specific to a term.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/invoices "Opens in new tab: Chargebee documentation")
[invoices schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/item_model/invoices.json "Opens in new tab: invoices schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/invoices#list_invoices "Opens in new tab: Chargebee API method") |
invoices table foreign keys
| Join invoices with | on |
| --- | --- |
| [addons](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#addons) | ``` invoices.notes.entity_id = addons.id ``` |
| [plans](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#plans) | ``` invoices.notes.entity_id = plans.applicable_addons.id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand adjustment\_credit\_notes
cn_create_reason_code
STRING
cn_date
DATE-TIME
cn_id
STRING
cn_reason_code
STRING
cn_status
STRING
cn_total
INTEGER
|
| --- |
| **amount\_adjusted**
INTEGER |
| **amount\_due**
INTEGER |
| **amount\_paid**
INTEGER |
| **amount\_to\_collect**
INTEGER |
| **applied\_credits**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand applied\_credits
applied_amount
INTEGER
applied_at
DATE-TIME
cn_create_reason_code
STRING
cn_date
DATE-TIME
cn_id
STRING
cn_reason_code
STRING
cn_status
STRING
|
| **base\_currency\_code**
STRING |
| **billing\_address**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand billing\_address
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
|
| **channel**
STRING |
| **credits\_applied**
INTEGER |
| **currency\_code**
STRING |
| **customer\_id**
STRING |
| **date**
DATE-TIME |
| **deleted**
BOOLEAN |
| **discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand discounts
amount
INTEGER
description
STRING
entity_id
STRING
entity_type
STRING
object
STRING
|
| **due\_date**
DATE-TIME |
| **dunning\_attempts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand dunning\_attempts
attempt
INTEGER
created_at
DATE-TIME
dunning_type
STRING
transaction_id
STRING
txn_amount
INTEGER
txn_status
STRING
|
| **dunning\_status**
STRING |
| **einvoice**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand einvoice
id
STRING
message
STRING
status
STRING
|
| **exchange\_rate**
NUMBER |
| **expected\_payment\_date**
DATE-TIME |
| **first\_invoice**
BOOLEAN |
| **generated\_at**
DATE-TIME |
| **has\_advance\_charges**
BOOLEAN |
| **id**
STRING |
| **is\_gifted**
BOOLEAN |
| **issued\_credit\_notes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand issued\_credit\_notes
cn_create_reason_code
STRING
cn_date
DATE-TIME
cn_id
STRING
cn_reason_code
STRING
cn_status
STRING
cn_total
INTEGER
|
| **line\_item\_discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_discounts
coupon_id
STRING
discount_amount
INTEGER
discount_type
STRING
entity_id
STRING
line_item_id
STRING
object
STRING
|
| **line\_item\_taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_taxes
is_non_compliance_tax
BOOLEAN
is_partial_tax_applied
BOOLEAN
line_item_id
STRING
local_currency_code
STRING
tax_amount
INTEGER
tax_amount_in_local_currency
INTEGER
tax_juris_code
STRING
tax_juris_name
STRING
tax_juris_type
STRING
tax_name
STRING
tax_rate
INTEGER, NUMBER
taxable_amount
INTEGER
|
| **line\_item\_tiers**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_tiers
ending_unit
INTEGER
ending_unit_in_decimal
STRING
line_item_id
STRING
quantity_used
INTEGER
quantity_used_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
unit_amount
INTEGER
unit_amount_in_decimal
STRING
|
| **line\_items**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_items
amount
INTEGER
amount_in_decimal
STRING
customer_id
STRING
date_from
DATE-TIME
date_to
DATE-TIME
description
STRING
discount_amount
INTEGER
entity_description
STRING
entity_id
STRING
entity_type
STRING
id
STRING
is_taxed
BOOLEAN
item_level_discount_amount
INTEGER
object
STRING
pricing_model
STRING
quantity
INTEGER
quantity_in_decimal
STRING
subscription_id
STRING
tax_amount
INTEGER
tax_exempt_reason
STRING
tax_rate
NUMBER
unit_amount
INTEGER
unit_amount_in_decimal
STRING
|
| **linked\_orders**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand linked\_orders
batch_id
STRING
created_at
DATE-TIME
document_number
STRING
fulfillment_status
STRING
id
STRING
order_type
STRING
reference_id
STRING
status
STRING
|
| **linked\_payments**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand linked\_payments
applied_amount
INTEGER
applied_at
DATE-TIME
txn_amount
INTEGER
txn_date
DATE-TIME
txn_id
STRING
txn_status
STRING
|
| **local\_currency\_code**
STRING |
| **net\_term\_days**
INTEGER |
| **new\_sales\_amount**
INTEGER |
| **next\_retry\_at**
DATE-TIME |
| **notes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand notes
entity_id
STRING
entity_type
STRING
note
STRING
|
| **object**
STRING |
| **paid\_at**
DATE-TIME |
| **payment\_owner**
STRING |
| **po\_number**
STRING |
| **price\_type**
STRING |
| **recurring**
BOOLEAN |
| **resource\_version**
INTEGER |
| **round\_off\_amount**
INTEGER |
| **shipping\_address**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand shipping\_address
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
|
| **status**
STRING |
| **sub\_total**
INTEGER |
| **sub\_total\_in\_local\_currency**
INTEGER |
| **subscription\_id**
STRING |
| **tax**
INTEGER |
| **taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand taxes
amount
INTEGER
description
STRING
name
STRING
|
| **term\_finalized**
BOOLEAN |
| **total**
INTEGER |
| **total\_in\_local\_currency**
INTEGER |
| **updated\_at**
DATE-TIME |
| **vat\_number**
STRING |
| **vat\_number\_prefix**
STRING |
| **void\_reason\_code**
STRING |
| **voided\_at**
DATE-TIME |
| **write\_off\_amount**
INTEGER |
### item\_families
The `item_families` table contains info about item families.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [item_families schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/item_model/item_families.json "Opens in new tab: item_families schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/item_families?prod_cat_ver=2#list_item_families "Opens in new tab: Chargebee API method") |
item\_families table foreign keys
| Join item\_families with | on |
| --- | --- |
| [item_prices](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#item-prices) | ``` item_families.id = item_prices.item_family_id ``` |
| [items](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#items) | ``` item_families.id = items.item_family_id ``` |
item\_families table schema
| **channel**
STRING |
| --- |
| **custom\_fields**
STRING |
| **description**
STRING |
| **id**
STRING |
| **name**
STRING |
| **object**
STRING |
| **resource\_version**
INTEGER |
| **status**
STRING |
| **updated\_at**
DATE-TIME |
### item\_prices
The `item_prices` table contains info about item prices.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [item_prices schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/item_model/item_prices.json "Opens in new tab: item_prices schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/item_prices?prod_cat_ver=2#list_item_prices "Opens in new tab: Chargebee API method") |
item\_prices table foreign keys
| Join item\_prices with | on |
| --- | --- |
| [item_families](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#item-families) | ``` item_prices.item_family_id = item_families.id ``` |
| [items](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#items) | ``` item_prices.item_family_id = items.item_family_id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand accounting\_detail
accounting_category1
STRING
accounting_category2
STRING
accounting_category3
STRING
accounting_category4
STRING
accounting_code
STRING
sku
STRING
|
| --- |
| **archivable**
BOOLEAN, STRING |
| **archived\_at**
DATE-TIME |
| **billing\_cycles**
INTEGER |
| **channel**
STRING |
| **created\_at**
DATE-TIME |
| **currency\_code**
STRING |
| **custom\_fields**
STRING |
| **description**
STRING |
| **external\_name**
STRING |
| **free\_quantity**
INTEGER |
| **free\_quantity\_in\_decimal**
STRING |
| **id**
STRING |
| **invoice\_notes**
STRING |
| **is\_taxable**
BOOLEAN |
| **item\_family\_id**
STRING |
| **item\_id**
STRING |
| **item\_type**
STRING |
| **metadata**
STRING |
| **name**
STRING |
| **object**
STRING |
| **period**
INTEGER |
| **period\_unit**
STRING |
| **price**
INTEGER |
| **price\_in\_decimal**
STRING |
| **pricing\_model**
STRING |
| **resource\_version**
INTEGER |
| **shipping\_period**
INTEGER |
| **shipping\_period\_unit**
STRING |
| **show\_description\_in\_invoices**
BOOLEAN |
| **show\_description\_in\_quotes**
BOOLEAN |
| **status**
STRING |
| **tax\_detail**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand tax\_detail
avalara_sale_type
STRING
avalara_service_type
INTEGER
avalara_tax_code
STRING
avalara_transaction_type
INTEGER
tax_profile_id
STRING
taxjar_product_code
STRING
|
| **tiers**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand tiers
ending_unit
INTEGER
price
INTEGER
starting_unit
INTEGER
|
| **trial\_end\_action**
STRING |
| **trial\_period**
INTEGER |
| **trial\_period\_unit**
STRING |
| **updated\_at**
DATE-TIME |
### items
The `items` table contains info about the items in your Chargebee account.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [items schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/item_model/items.json "Opens in new tab: items schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/items?prod_cat_ver=2#list_items "Opens in new tab: Chargebee API method") |
items table foreign keys
| Join items with | on |
| --- | --- |
| [item_families](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#item-families) | ``` items.item_family_id = item_families.id ``` |
| [item_prices](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#item-prices) | ``` items.item_family_id = item_prices.item_family_id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand applicable\_items
id
STRING
|
| --- |
| **archivable**
BOOLEAN, STRING |
| **archived\_at**
DATE-TIME |
| **channel**
STRING |
| **custom\_fields**
STRING |
| **description**
STRING |
| **enabled\_for\_checkout**
BOOLEAN |
| **enabled\_in\_portal**
BOOLEAN |
| **external\_name**
STRING |
| **gift\_claim\_redirect\_url**
STRING |
| **id**
STRING |
| **included\_in\_mrr**
BOOLEAN |
| **is\_giftable**
BOOLEAN |
| **is\_shippable**
BOOLEAN |
| **item\_applicability**
STRING |
| **item\_family\_id**
STRING |
| **metadata**
STRING |
| **metered**
BOOLEAN |
| **name**
STRING |
| **object**
STRING |
| **redirect\_url**
STRING |
| **resource\_version**
INTEGER |
| **status**
STRING |
| **type**
STRING |
| **unit**
STRING |
| **updated\_at**
DATE-TIME |
| **usage\_calculation**
STRING |
### orders
The `orders` table contains info about the orders in your Chargebee account. The **Order Management** feature must be enabled to replicate this table. For more information, refer to the [Chargebee docs](https://www.chargebee.com/docs/orders.html).
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/orders "Opens in new tab: Chargebee documentation")
[orders schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/orders.json "Opens in new tab: orders schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/orders#list_orders "Opens in new tab: Chargebee API method") |
orders table foreign keys
| Join orders with | on |
| --- | --- |
| [coupons](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#coupons) | ``` orders.line_item_discounts.coupon_id = coupons.id ``` |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` orders.line_item_discounts.coupon_id = credit_notes.discounts.entity_id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand billing\_address
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
|
| **cancellation\_reason**
STRING |
| **cancelled\_at**
DATE-TIME |
| **created\_at**
DATE-TIME |
| **created\_by**
STRING |
| **currency\_code**
STRING |
| **customer\_id**
STRING |
| **deleted**
BOOLEAN |
| **delivered\_at**
DATE-TIME |
| **discount**
INTEGER |
| **document\_number**
STRING |
| **fulfillment\_status**
STRING |
| **gift\_id**
STRING |
| **gift\_note**
STRING |
| **id**
STRING |
| **invoice\_id**
STRING |
| **invoice\_round\_off\_amount**
INTEGER |
| **is\_gifted**
BOOLEAN |
| **is\_resent**
BOOLEAN |
| **line\_item\_discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_discounts
coupon_id
STRING
discount_amount
INTEGER
discount_type
STRING
line_item_id
STRING
|
| **line\_item\_taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_taxes
is_non_compliance_tax
BOOLEAN
is_partial_tax_applied
BOOLEAN
line_item_id
STRING
local_currency_code
STRING
tax_amount
INTEGER
tax_amount_in_local_currency
INTEGER
tax_juris_code
STRING
tax_juris_name
STRING
tax_juris_type
STRING
tax_name
STRING
tax_rate
INTEGER, NUMBER
taxable_amount
INTEGER
|
| **linked\_credit\_notes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand linked\_credit\_notes
amount
INTEGER
amount_adjusted
INTEGER
amount_refunded
INTEGER
id
STRING
status
STRING
type
STRING
|
| **note**
STRING |
| **order\_date**
DATE-TIME |
| **order\_line\_items**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand order\_line\_items
amount
INTEGER
amount_adjusted
INTEGER
amount_paid
INTEGER
description
STRING
discount_amount
INTEGER
entity_id
STRING
entity_type
STRING
fulfillment_amount
INTEGER
fulfillment_quantity
INTEGER
id
STRING
invoice_id
STRING
invoice_line_item_id
STRING
is_shippable
BOOLEAN
item_level_discount_amount
INTEGER
refundable_credits
INTEGER
refundable_credits_issued
INTEGER
sku
STRING
status
STRING
tax_amount
INTEGER
unit_price
INTEGER
|
| **order\_type**
STRING |
| **original\_order\_id**
STRING |
| **paid\_on**
DATE-TIME |
| **payment\_status**
STRING |
| **price\_type**
STRING |
| **reference\_id**
STRING |
| **refundable\_credits**
INTEGER |
| **refundable\_credits\_issued**
INTEGER |
| **resend\_reason**
STRING |
| **resent\_orders**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand resent\_orders
amount
INTEGER
order_id
STRING
reason
STRING
|
| **resent\_status**
STRING |
| **resource\_version**
INTEGER |
| **rounding\_adjustement**
INTEGER |
| **shipment\_carrier**
STRING |
| **shipped\_at**
DATE-TIME |
| **shipping\_address**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand shipping\_address
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status,
STRING
zip
STRING
|
| **shipping\_cut\_off\_date**
DATE-TIME |
| **shipping\_date**
DATE-TIME |
| **status**
STRING |
| **status\_update\_at**
DATE-TIME |
| **sub\_total**
INTEGER |
| **subscription\_id**
STRING |
| **tax**
INTEGER |
| **total**
INTEGER |
| **tracking\_id**
STRING |
| **tracking\_url**
STRING |
| **updated\_at**
DATE-TIME |
### payment\_sources
The `payment_sources` table contains info about customer payment sources.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/payment_sources "Opens in new tab: Chargebee documentation")
[payment_sources schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/payment_sources.json "Opens in new tab: payment_sources schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/payment_sources#list_payment_sources "Opens in new tab: Chargebee API method") |
payment\_sources table foreign keys
| Join payment\_sources with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` payment_sources.customer_id = credit_notes.customer_id ``` |
| [customers](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#customers) | ``` payment_sources.customer_id = customers.id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand amazon\_payment
agreement_id
STRING
email
STRING
|
| --- |
| **bank\_account**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand bank\_account
account_holder_type
STRING
account_type
STRING
bank_name
STRING
echeck_type
STRING
last4
STRING
mandate_id
STRING
name_on_account
STRING
|
| **card**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand card
billing_addr1
STRING
billing_addr2
STRING
billing_city
STRING
billing_country
STRING
billing_state
STRING
billing_state_code
STRING
billing_zip
STRING
brand
STRING
expiry_month
INTEGER
expiry_year
INTEGER
first_name
STRING
funding_type
STRING
iin
STRING
last4
STRING
last_name
STRING
masked_number
STRING
object
STRING
|
| **created\_at**
DATE-TIME |
| **customer\_id**
STRING |
| **deleted**
BOOLEAN |
| **gateway**
STRING |
| **gateway\_account\_id**
STRING |
| **id**
STRING |
| **ip\_address**
STRING |
| **issuing\_country**
STRING |
| **mandates**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand mandates
created_at
DATE-TIME
id
STRING
subscription_id
STRING
|
| **object**
STRING |
| **paypal**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand paypal
agremeent_id
STRING
email
STRING
|
| **reference\_id**
STRING |
| **resource\_version**
INTEGER |
| **status**
STRING |
| **type**
STRING |
| **updated\_at**
DATE-TIME |
| **upi**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand upi
vpa
STRING
|
### plans
The `plans` table contains info about the plans in your Chargebee account. Plans are used to specify prices and billing frequencies for [`subscriptions`](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#subscriptions).
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [plans schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/plan_model/plans.json "Opens in new tab: plans schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/plans?prod_cat_ver=1#list_plans "Opens in new tab: Chargebee API method") |
plans table foreign keys
| Join plans with | on |
| --- | --- |
| [addons](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#addons) | ``` plans.applicable_addons.id = addons.id ``` |
| [invoices](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#invoices) | ``` plans.applicable_addons.id = invoices.notes.entity_id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand applicable\_addons
id
STRING
quantity_in_decimal
STRING
|
| **archived\_at**
DATE-TIME |
| **attached\_addons**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand attached\_addons
billing_cycles
INTEGER
id
STRING
quantity
INTEGER
quantity_in_decimal
STRING
type
STRING
|
| **avalara\_sale\_type**
STRING |
| **avalara\_service\_type**
INTEGER |
| **avalara\_transaction\_type**
INTEGER |
| **billing\_cycles**
INTEGER |
| **channel**
STRING |
| **charge\_model**
STRING |
| **claim\_url**
STRING |
| **currency\_code**
STRING |
| **custom\_fields**
STRING |
| **description**
STRING |
| **enabled\_in\_hosted\_pages**
BOOLEAN |
| **enabled\_in\_portal**
BOOLEAN |
| **event\_based\_addons**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand event\_based\_addons
charge_once
BOOLEAN
id
STRING
on_event
STRING
quantity
INTEGER
quantity_in_decimal
STRING
|
| **free\_quantity**
INTEGER |
| **free\_quantity\_in\_decimal**
STRING |
| **giftable**
BOOLEAN |
| **id**
STRING |
| **invoice\_name**
STRING |
| **invoice\_notes**
STRING |
| **is\_shippable**
BOOLEAN |
| **meta\_data**
STRING |
| **name**
STRING |
| **object**
STRING |
| **period**
INTEGER |
| **period\_unit**
STRING |
| **price**
INTEGER |
| **price\_in\_decimal**
STRING |
| **pricing\_model**
STRING |
| **redirect\_url**
STRING |
| **resource\_version**
INTEGER |
| **setup\_cost**
INTEGER |
| **shipping\_frequency\_period**
INTEGER |
| **shipping\_frequency\_period\_unit**
STRING |
| **show\_description\_in\_invoices**
BOOLEAN |
| **show\_description\_in\_quotes**
BOOLEAN |
| **sku**
STRING |
| **status**
STRING |
| **tax\_code**
STRING |
| **tax\_profile\_id**
STRING |
| **taxable**
BOOLEAN |
| **taxjar\_product\_code**
STRING |
| **tiers**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand tiers
ending_unit
INTEGER
ending_unit_in_decimal
STRING
price
INTEGER
price_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
|
| **trial\_end\_action**
STRING |
| **trial\_period**
INTEGER |
| **trial\_period\_unit**
STRING |
| **updated\_at**
DATE-TIME |
### promotional\_credits
The `promotional_credits` table contains info about the promotional\_credits in your Chargebee account.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | created\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/promotional_credits "Opens in new tab: Chargebee documentation")
[promotional_credits schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/item_model/promotional_credits.json "Opens in new tab: promotional_credits schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/promotional_credits#list_promotional_credits "Opens in new tab: Chargebee API method") |
promotional\_credits table foreign keys
| Join promotional\_credits with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` promotional_credits.customer_id = credit_notes.customer_id ``` |
| [customers](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#customers) | ``` promotional_credits.customer_id = customers.id ``` |
| [events](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#events) | ``` promotional_credits.customer_id = events.content.customer.id ```
STRING |
### quotes
The `quotes` table contains info about quotes in your Chargebee account.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/quotes "Opens in new tab: Chargebee documentation")
[quotes schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/common/quotes.json "Opens in new tab: quotes schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/quotes#list_quotes "Opens in new tab: Chargebee API method") |
quotes table schema
| **amount\_due**
INTEGER |
| --- |
| **amount\_paid**
INTEGER |
| **billing\_address**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand discounts
amount
INTEGER
description
STRING
entity_id
STRING
entity_type
STRING
object
STRING
|
| **id**
STRING |
| **invoice\_id**
STRING |
| **line\_item\_discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_discounts
coupon_id
STRING
discount_amount
INTEGER
discount_type
STRING
entity_id
STRING
line_item_id
STRING
|
| **line\_item\_taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_taxes
is_non_compliance_tax
BOOLEAN
is_partial_tax_applied
BOOLEAN
line_item_id
STRING
tax_amount
INTEGER
tax_juris_code
STRING
tax_juris_name
STRING
tax_juris_type
STRING
tax_name
STRING
tax_rate
INTEGER
taxable_amount
INTEGER
|
| **line\_item\_tiers**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_item\_tiers
ending_unit
INTEGER
line_item_id
STRING
quantity_used
INTEGER
starting_unit
INTEGER
unit_amount
INTEGER
|
| **line\_items**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand line\_items
amount
INTEGER
date_from
DATE-TIME
date_to
DATE-TIME
description
STRING
discount_amount
INTEGER
entity_id
STRING
entity_type
STRING
id
STRING
is_taxed
BOOLEAN
item_level_discount_amount
INTEGER
object
STRING
pricing_model
STRING
quantity
INTEGER
subscription_id
STRING
tax_amount
INTEGER
tax_exempt_reason
STRING
tax_rate
INTEGER
unit_amount
INTEGER
|
| **name**
STRING |
| **notes**
STRING |
| **operation\_type**
STRING |
| **po\_number**
STRING |
| **price\_type**
STRING |
| **resource\_version**
INTEGER |
| **shipping\_address**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand shipping\_address
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status,
STRING
zip
STRING
|
| **status**
STRING |
| **sub\_total**
INTEGER |
| **subscription\_id**
STRING |
| **taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand taxes
amount
INTEGER
description
STRING
name
STRING
|
| **total**
INTEGER |
| **total\_payable**
INTEGER |
| **updated\_at**
DATE-TIME |
| **valid\_till**
DATE-TIME |
| **vat\_number**
STRING |
| **vat\_number\_prefix**
STRING |
| **version**
INTEGER |
### subscriptions
The `subscriptions` table contains info about the subscriptions your customers have subscribed to. A subscription is a recurring item that customers are billed for, such as a plan or addon. It may also contain discount items.
**Note**: Chargebee [does not update the `updated_at`](https://apidocs.chargebee.com/docs/api/subscriptions#subscription_updated_at) value when the following attributes on a subscription are modified:
* `due_invoices_count`
* `due_since`
* `total_dues`
Because of this functionality and Stitch’s use of this value as a [Replication Key](https://help.qlik.com/en-US/stitch/replication/replication-keys), updates made to subscriptions where only these attributes are modified may not be detected. You should ensure that another attribute on the subscription is also modified to ensure that the `updated_at` value is updated, which will allow Stitch to detect and replicate the record.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/subscriptions "Opens in new tab: Chargebee documentation")
[subscriptions schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/item_model/subscriptions.json "Opens in new tab: subscriptions schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/subscriptions#list_subscriptions "Opens in new tab: Chargebee API method") |
subscriptions table foreign keys
| Join subscriptions with | on |
| --- | --- |
| [coupons](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#coupons) | ``` subscriptions.coupons.coupon_id = coupons.id ``` |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` subscriptions.coupons.coupon_id = credit_notes.discounts.entity_id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand charged\_items
item_price_id
STRING
last_charged_at
DATE-TIME
object
STRING
|
| **contract\_term**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand coupons
applied_count
INTEGER
apply_till
DATE-TIME
coupon_code
STRING
coupon_id
STRING
object
STRING
|
| **create\_pending\_invoices**
BOOLEAN |
| **created\_at**
DATE-TIME |
| **created\_from\_ip**
STRING |
| **currency\_code**
STRING |
| **current\_term\_end**
DATE-TIME |
| **current\_term\_start**
DATE-TIME |
| **custom\_fields**
STRING |
| **customer\_id**
STRING |
| **deleted**
BOOLEAN |
| **discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand discounts
amount
NUMBER
applied_count
INTEGER
apply_on
STRING
apply_till
INTEGER
coupon_id
STRING
created_at
INTEGER
currency_code
STRING
duration_type
STRING
id
STRING
included_in_mrr
BOOLEAN
index
INTEGER
invoice_name
STRING
item_price_id
STRING
name
STRING
object
STRING
percentage
NUMBER
period
INTEGER
period_unit
STRING
resource_version
INTEGER
type
STRING
updated_at
INTEGER
|
| **due\_invoices\_count**
INTEGER |
| **due\_since**
DATE-TIME |
| **exchange\_rate**
NUMBER |
| **free\_period**
INTEGER |
| **free\_period\_unit**
STRING |
| **has\_scheduled\_advance\_invoices**
BOOLEAN |
| **has\_scheduled\_changes**
BOOLEAN |
| **id**
STRING |
| **invoice\_notes**
STRING |
| **item\_tiers**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand item\_tiers
ending_unit
INTEGER
ending_unit_in_decimal
STRING
item_price_id
STRING
price
INTEGER
price_in_decimal
STRING
starting_unit
INTEGER
starting_unit_in_decimal
STRING
|
| **meta\_data**
STRING |
| **mrr**
INTEGER |
| **next\_billing\_at**
DATE-TIME |
| **object**
STRING |
| **override\_relationship**
BOOLEAN |
| **pause\_date**
DATE-TIME |
| **payment\_source\_id**
STRING |
| **plan\_amount\_in\_decimal**
STRING |
| **plan\_free\_quantity\_in\_decimal**
STRING |
| **plan\_quantity\_in\_decimal**
STRING |
| **plan\_unit\_price\_in\_decimal**
STRING |
| **po\_number**
STRING |
| **referral\_info**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand referral\_info
account_id
STRING
campaign_id
STRING
coupon_code
STRING
destination_url
STRING
external_campaign_id
STRING
external_reference_id
STRING
friend_offer_type
STRING
notify_referral_system
STRING
post_purchase_widget_enabled
BOOLEAN
referral_code
STRING
referral_system
STRING
referrer_id
STRING
referrer_reward_type
STRING
reward_status
STRING
|
| **remaining\_billing\_cycles**
INTEGER |
| **resource\_version**
INTEGER |
| **resume\_date**
DATE-TIME |
| **shipping\_address**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand shipping\_address
city
STRING
company
STRING
country
STRING
email
STRING
first_name
STRING
last_name
STRING
line1
STRING
line2
STRING
line3
STRING
object
STRING
phone
STRING
state
STRING
state_code
STRING
validation_status
STRING
zip
STRING
|
| **start\_date**
DATE-TIME |
| **started\_at**
DATE-TIME |
| **status**
STRING |
| **subscription\_items**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand subscription\_items
amount
INTEGER
amount_in_decimal
STRING
billing_cycles
INTEGER
charge_on_event
STRING
charge_on_option
STRING
charge_once
BOOLEAN
free_quantity
INTEGER
free_quantity_in_decimal
STRING
item_price_id
STRING
item_type
STRING
object
STRING
quantity
INTEGER
quantity_in_decimal
STRING
service_period_days
INTEGER
trial_end
DATE-TIME
unit_price
INTEGER
unit_price_in_decimal
STRING
|
| **total\_dues**
INTEGER |
| **trial\_end**
DATE-TIME |
| **trial\_end\_action**
STRING |
| **trial\_start**
DATE-TIME |
| **updated\_at**
DATE-TIME |
### transactions
The `transactions` table contains info about the transactions that have occurred in your Chargebee account.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/transactions "Opens in new tab: Chargebee documentation")
[transactions schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/transactions.json "Opens in new tab: transactions schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/transactions#list_transactions "Opens in new tab: Chargebee API method") |
transactions table foreign keys
| Join transactions with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` transactions.customer_id = credit_notes.customer_id ```
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand linked\_credit\_notes
applied_amount
INTEGER
applied_at
DATE-TIME
cn_create_reason_code
STRING
cn_date
DATE-TIME
cn_id
STRING
cn_reason_code
STRING
cn_reference_invoice_id
STRING
cn_status
STRING
cn_total
INTEGER
|
| **linked\_invoices**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand linked\_invoices
applied_amount
INTEGER
applied_at
DATE-TIME
invoice_date
DATE-TIME
invoice_id
STRING
invoice_status
STRING
invoice_total
INTEGER
|
| **linked\_payments**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand linked\_payments
amount
INTEGER
date
DATE-TIME
id
STRING
status
STRING
|
| **linked\_refunds**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand linked\_refunds
txn_amount
INTEGER
txn_date
DATE-TIME
txn_id
STRING
txn_status
STRING
|
| **masked\_card\_number**
STRING |
| **merchant\_reference\_id**
STRING |
| **object**
STRING |
| **payment\_method**
STRING |
| **payment\_source\_id**
STRING |
| **reference\_authorization\_id**
STRING |
| **reference\_number**
STRING |
| **reference\_transaction\_id**
STRING |
| **refunded\_txn\_id**
STRING |
| **resource\_version**
INTEGER |
| **reversal\_transaction\_id**
STRING |
| **reversal\_txn\_id**
STRING |
| **settled\_at**
DATE-TIME |
| **status**
STRING |
| **subscription\_id**
STRING |
| **three\_d\_secure**
BOOLEAN |
| **type**
STRING |
| **updated\_at**
DATE-TIME |
| **validated\_at**
DATE-TIME |
| **voided\_at**
DATE-TIME |
### virtual\_bank\_accounts
The `virtual_bank_accounts` table contains info about the virtual bank accounts in your Chargebee account. A virtual bank account is a unique account number that can be shared with your users while still protecting your sensitive bank account details.
**Note**: This table is available Refer to the [Table and field availability and Chargebee Product Catalogs section](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#product-catalog-versions) for more info.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Chargebee documentation](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts "Opens in new tab: Chargebee documentation")
[virtual_bank_accounts schema on GitHub](https://github.com/singer-io/tap-chargebee/blob/master/tap_chargebee/schemas/virtual_bank_accounts.json "Opens in new tab: virtual_bank_accounts schema on GitHub")
[Chargebee API method](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts#list_virtual_bank_accounts "Opens in new tab: Chargebee API method") |
virtual\_bank\_accounts table foreign keys
| Join virtual\_bank\_accounts with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#credit-notes) | ``` virtual_bank_accounts.customer_id = credit_notes.customer_id ``` |
| [customers](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#customers) | ``` virtual_bank_accounts.customer_id = customers.id ``` |
| [events](https://help.qlik.com/en-US/stitch/integrations/saas/chargebee#events) | ``` virtual_bank_accounts.customer_id = events.content.customer.id ```