---
title: "Chargebee Data Model"
description: "Billing recurring revenues for SaaS providers."
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/chargebee
original: https://documentation.invantive.eu/en/datamodels/chargebee
updated: 2024-06-10T18:44:26Z
license: https://documentation.invantive.eu/en/
---

# Chargebee Data Model

Authentication
Authentication is done using an API key. An API key can be found and/or registered on https://SERVER/apikeys_and_webhooks/api. The API key is valid for a specific site.
The Chargebee API key can be configured in settings.xml as the value of defaultPassword attribute of the database element. The site is derived from the connection string attribute 'server'.
Beware that after deleting records, Chargebee can still return those records for some time (at least 5 seconds).

Set up this platform in Invantive Cloud: https://cloud.invantive.com/chargebee

Text comparisons on this platform are case sensitive.

## Platform

- Used from: Invantive Cloud and the Invantive products on your own computer or server.
- Kind: an application reached over its API.
- The data is partitioned, such as per company or administration.
- Data can be written as well as read.
- Invantive Cloud plans: Office for Entrepreneurs, Office for Accountants, Premium Finance, OEM.
- Status of the platform: [https://status.chargebee.com/](https://status.chargebee.com/).

## Figures

| Figure | Count |
|---|---:|
| Tables | 114 |
| Columns | 1,534 |

## Tables

### Chargebee.Addons

- [AddonCustomFieldValues](Chargebee.Addons.AddonCustomFieldValues): Addon Custom Fields
- [AddonTiers](Chargebee.Addons.AddonTiers): Add-on Tiers
- [Addons](Chargebee.Addons.Addons): Add-ons

### Chargebee.Addresses

- [Addresses](Chargebee.Addresses.Addresses): Addresses

### Chargebee.BusinessEntities

- [BusinessEntities](Chargebee.BusinessEntities.BusinessEntities): Business Entities
- [BusinessEntityTransfers](Chargebee.BusinessEntities.BusinessEntityTransfers): Business Entity Transfers

### Chargebee.Comments

- [Comments](Chargebee.Comments.Comments): Comments

### Chargebee.Coupons

- [CouponAddons](Chargebee.Coupons.CouponAddons): Coupon Add-ons
- [CouponCodes](Chargebee.Coupons.CouponCodes): Coupon Codes
- [CouponConstraints](Chargebee.Coupons.CouponConstraints): Coupon Constraints
- [CouponItemConstraintCriteria](Chargebee.Coupons.CouponItemConstraintCriteria): Coupon Item Constraint Criteria
- [CouponItemConstraints](Chargebee.Coupons.CouponItemConstraints): Coupon Item Constraints
- [CouponPlans](Chargebee.Coupons.CouponPlans): Coupon Plans
- [CouponSets](Chargebee.Coupons.CouponSets): Coupon Sets
- [Coupons](Chargebee.Coupons.Coupons): Coupons

### Chargebee.CreditNotes

- [CreditNotes](Chargebee.CreditNotes.CreditNotes): Credit Notes

### Chargebee.Currencies

- [Currencies](Chargebee.Currencies.Currencies): Currencies

### Chargebee.CustomFields

- [CustomFieldConfigurations](Chargebee.CustomFields.CustomFieldConfigurations): Custom Field Configs

### Chargebee.Customers

- [Cards](Chargebee.Customers.Cards): Cards
- [CustomerBalances](Chargebee.Customers.CustomerBalances): Customer Balances
- [CustomerContacts](Chargebee.Customers.CustomerContacts): Customer Contacts
- [CustomerCustomFieldValues](Chargebee.Customers.CustomerCustomFieldValues): Customer Custom Fields
- [CustomerReferralUrls](Chargebee.Customers.CustomerReferralUrls): Customer Referral URLs
- [Customers](Chargebee.Customers.Customers): Customers

### Chargebee.Entitlements

- [EntitlementOverrides](Chargebee.Entitlements.EntitlementOverrides): Entitlement Overrides
- [Entitlements](Chargebee.Entitlements.Entitlements): Entitlements
- [FeatureLevels](Chargebee.Entitlements.FeatureLevels): Feature Levels
- [Features](Chargebee.Entitlements.Features): Features
- [SubscriptionEntitlements](Chargebee.Entitlements.SubscriptionEntitlements): Subscription Entitlements

### Chargebee.Events

- [EventWebhooks](Chargebee.Events.EventWebhooks): Event Webhooks
- [Events](Chargebee.Events.Events): Events

### Chargebee.Gifts

- [GiftTimelines](Chargebee.Gifts.GiftTimelines): Gift Timelines
- [Gifts](Chargebee.Gifts.Gifts): Gifts

### Chargebee.HostedPages

- [HostedPageContents](Chargebee.HostedPages.HostedPageContents): Hosted Page Contents
- [HostedPages](Chargebee.HostedPages.HostedPages): Hosted Pages

### Chargebee.InAppPurchases

- [InAppSubscriptionsById](Chargebee.InAppPurchases.InAppSubscriptionsById): In App Subscriptions

### Chargebee.Invoices

- [InstallmentConfigurations](Chargebee.Invoices.InstallmentConfigurations): Installment Configurations
- [Installments](Chargebee.Invoices.Installments): Installment Configurations
- [InvoiceAdjustmentCreditNotes](Chargebee.Invoices.InvoiceAdjustmentCreditNotes): Invoice Adjustment Credit Notes
- [InvoiceAppliedCredits](Chargebee.Invoices.InvoiceAppliedCredits): Invoice Applied Credits
- [InvoiceCreditNotes](Chargebee.Invoices.InvoiceCreditNotes): Invoice Credit Notes
- [InvoiceDiscounts](Chargebee.Invoices.InvoiceDiscounts): Invoice Discounts
- [InvoiceDunningAttempts](Chargebee.Invoices.InvoiceDunningAttempts): Invoice Dunning Attempts
- [InvoiceLineItemDiscounts](Chargebee.Invoices.InvoiceLineItemDiscounts): Invoice Line Item Discounts
- [InvoiceLineItemTaxes](Chargebee.Invoices.InvoiceLineItemTaxes): Invoice Line Item Taxes
- [InvoiceLineItemTiers](Chargebee.Invoices.InvoiceLineItemTiers): Invoice Line Item Tiers
- [InvoiceLineItems](Chargebee.Invoices.InvoiceLineItems): Invoice Line Items
- [InvoiceLinkedOrders](Chargebee.Invoices.InvoiceLinkedOrders): Invoice Linked Orders
- [InvoiceLinkedPayments](Chargebee.Invoices.InvoiceLinkedPayments): Invoice Linked Payments
- [InvoiceNotes](Chargebee.Invoices.InvoiceNotes): Invoice Notes
- [InvoicePdfById](Chargebee.Invoices.InvoicePdfById): Invoice as PDF
- [InvoiceTaxes](Chargebee.Invoices.InvoiceTaxes): Invoice Taxes
- [Invoices](Chargebee.Invoices.Invoices): Invoices
- [PaymentReferenceNumbers](Chargebee.Invoices.PaymentReferenceNumbers): Payment Reference Numbers
- [QuoteLineItemTiers](Chargebee.Invoices.QuoteLineItemTiers): Quote Line Item Tiers

### Chargebee.Items

- [ItemFamilies](Chargebee.Items.ItemFamilies): Item Families
- [ItemPrices](Chargebee.Items.ItemPrices): Item Prices
- [Items](Chargebee.Items.Items): Items

### Chargebee.Native

- [NATIVEPLATFORMSCALARREQUESTS](Chargebee.Native.NATIVEPLATFORMSCALARREQUESTS): Native Platform Scalar Requests

### Chargebee.Orders

- [OrderLineItemDiscounts](Chargebee.Orders.OrderLineItemDiscounts): Order Line Item Discounts
- [OrderLineItemTaxes](Chargebee.Orders.OrderLineItemTaxes): Order Line Item Taxes
- [OrderLineItems](Chargebee.Orders.OrderLineItems): Order Line Items
- [OrderLinkedCreditNotes](Chargebee.Orders.OrderLinkedCreditNotes): Order Linked Credit Notes
- [OrderResentOrders](Chargebee.Orders.OrderResentOrders): Order Resent Orders
- [Orders](Chargebee.Orders.Orders): Orders

### Chargebee.Plans

- [PlanApplicableAddons](Chargebee.Plans.PlanApplicableAddons): Plan Applicable Add-ons
- [PlanAttachedAddons](Chargebee.Plans.PlanAttachedAddons): Plan Attached Add-ons
- [PlanCustomFieldValues](Chargebee.Plans.PlanCustomFieldValues): Plan Custom Fields
- [PlanEventBasedAddons](Chargebee.Plans.PlanEventBasedAddons): Plan Event-based Add-ons
- [PlanTiers](Chargebee.Plans.PlanTiers): Plan Tiers
- [Plans](Chargebee.Plans.Plans): Plans

### Chargebee.PromotionalCredits

- [PromotionalCredits](Chargebee.PromotionalCredits.PromotionalCredits): Promotional Credits

### Chargebee.Quotes

- [QuoteDiscounts](Chargebee.Quotes.QuoteDiscounts): Quote Discounts
- [QuoteLineGroups](Chargebee.Quotes.QuoteLineGroups): Quote Line Groups
- [QuoteLineItemDiscounts](Chargebee.Quotes.QuoteLineItemDiscounts): Quote Line Item Discounts
- [QuoteLineItemTaxes](Chargebee.Quotes.QuoteLineItemTaxes): Quote Line Item Taxes
- [QuoteLineItems](Chargebee.Quotes.QuoteLineItems): Quote Line Items
- [QuoteNotes](Chargebee.Quotes.QuoteNotes): Quote Notes
- [QuoteTaxes](Chargebee.Quotes.QuoteTaxes): Quote Taxes
- [Quotes](Chargebee.Quotes.Quotes): Quotes

### Chargebee.SiteMigrationDetails

- [SiteMigrationDetails](Chargebee.SiteMigrationDetails.SiteMigrationDetails): Site Migration Details

### Chargebee.Subscriptions

- [PaymentSourceMandates](Chargebee.Subscriptions.PaymentSourceMandates): Payment Source Mandates
- [PaymentSources](Chargebee.Subscriptions.PaymentSources): Payment Sources
- [PurchaseInvoiceIDs](Chargebee.Subscriptions.PurchaseInvoiceIDs): Purchase Invoice IDs
- [PurchaseSubscriptionIDs](Chargebee.Subscriptions.PurchaseSubscriptionIDs): Purchase Subscription IDs
- [Purchases](Chargebee.Subscriptions.Purchases): Purchases
- [RampCouponsToAdd](Chargebee.Subscriptions.RampCouponsToAdd): Ramp Coupons to Add
- [RampCouponsToRemove](Chargebee.Subscriptions.RampCouponsToRemove): Ramp Coupons to Remove
- [RampDiscountsToAdd](Chargebee.Subscriptions.RampDiscountsToAdd): Ramp Discounts to Add
- [RampDiscountsToRemove](Chargebee.Subscriptions.RampDiscountsToRemove): Ramp Discounts to Remove
- [RampItemTiers](Chargebee.Subscriptions.RampItemTiers): Ramp Item Tiers
- [RampItemsToAdd](Chargebee.Subscriptions.RampItemsToAdd): Ramp Items to Add
- [RampItemsToRemove](Chargebee.Subscriptions.RampItemsToRemove): Ramp Items to Remove
- [RampItemsToUpdate](Chargebee.Subscriptions.RampItemsToUpdate): Ramp Items to Update
- [Ramps](Chargebee.Subscriptions.Ramps): Ramps
- [SubscriptionAddons](Chargebee.Subscriptions.SubscriptionAddons): Subscription Add-ons
- [SubscriptionChargedEventBasedAddons](Chargebee.Subscriptions.SubscriptionChargedEventBasedAddons): Subscription-charged Event-based Add-ons
- [SubscriptionChargedItems](Chargebee.Subscriptions.SubscriptionChargedItems): Subscription Items
- [SubscriptionCoupons](Chargebee.Subscriptions.SubscriptionCoupons): Subscription Coupons
- [SubscriptionCustomFieldValues](Chargebee.Subscriptions.SubscriptionCustomFieldValues): Subscription Custom Fields
- [SubscriptionDiscounts](Chargebee.Subscriptions.SubscriptionDiscounts): Subscription Items
- [SubscriptionEventBasedAddons](Chargebee.Subscriptions.SubscriptionEventBasedAddons): Subscription Event-based Add-ons
- [SubscriptionItemTiers](Chargebee.Subscriptions.SubscriptionItemTiers): Subscription Items
- [SubscriptionItems](Chargebee.Subscriptions.SubscriptionItems): Subscription Items
- [Subscriptions](Chargebee.Subscriptions.Subscriptions): Subscriptions
- [UsagesBySubscriptionID](Chargebee.Subscriptions.UsagesBySubscriptionID): Usages by Subscription ID

### Chargebee.Transactions

- [TransactionLinkedCreditNotes](Chargebee.Transactions.TransactionLinkedCreditNotes): Transaction Linked Credit Notes
- [TransactionLinkedInvoices](Chargebee.Transactions.TransactionLinkedInvoices): Transaction Linked Invoices
- [TransactionLinkedPayments](Chargebee.Transactions.TransactionLinkedPayments): Transaction Linked Payments
- [TransactionLinkedRefunds](Chargebee.Transactions.TransactionLinkedRefunds): Transaction Linked Refunds
- [Transactions](Chargebee.Transactions.Transactions): Subscription Add-ons

### Chargebee.UnbilledCharges

- [UnbilledChargeTiers](Chargebee.UnbilledCharges.UnbilledChargeTiers): Unbilled Charge Tiers
- [UnbilledCharges](Chargebee.UnbilledCharges.UnbilledCharges): Unbilled Charges

### Chargebee.VirtualBankAccounts

- [VirtualBankAccounts](Chargebee.VirtualBankAccounts.VirtualBankAccounts): Virtual Bank Accounts

## Attributes

The attributes of this platform are on the page [Attributes](attributes).



## Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

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

