invantive documentation
Invantive Support ForumsLog In / Sign Up

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/.

Figures

Figure Count
Tables 114
Columns 1,534

Data Model Poster

This data model declares no keys yet; the dotted relations are derived from column names.

PDF, 1 A0 sheet

On a table of the poster: plus and minus zoom, the arrow keys move, 0 fits.

Chargebee data model, Sheet 1 of 1Chargebee data modelfor use with Invantive UniversalSQLRelease 24.1.3-BETA+4689 · 10-06-2024Subscription · Invoice · Quote · Customer · Order · Ramp · Coupon · Plan · Transaction · Payment · Other · Addon · PurchaseSheet 1 of 1 · documentation.invantive.euSubscriptionChargebee.Entitlements.EntitlementOverrides: Entitlement OverridesEntitlementOverridesChargebee.Entitlements.Entitlements: EntitlementsEntitlementsChargebee.Entitlements.FeatureLevels: Feature LevelsFeatureLevelsChargebee.Entitlements.Features: FeaturesFeaturesChargebee.Entitlements.SubscriptionEntitlements: Subscription EntitlementsSubscriptionEntitlementsChargebee.Subscriptions.SubscriptionAddons: Subscription Add-onsSubscriptionAddonsChargebee.Subscriptions.SubscriptionChargedEventBasedAddons: Subscription-charged Event-based Add-onsSubscriptionChargedEventBasedAdd…Chargebee.Subscriptions.SubscriptionChargedItems: Subscription ItemsSubscriptionChargedItemsChargebee.Subscriptions.SubscriptionCoupons: Subscription CouponsSubscriptionCouponsChargebee.Subscriptions.SubscriptionCustomFieldValues: Subscription Custom FieldsSubscriptionCustomFieldValuesChargebee.Subscriptions.SubscriptionDiscounts: Subscription ItemsSubscriptionDiscountsChargebee.Subscriptions.SubscriptionEventBasedAddons: Subscription Event-based Add-onsSubscriptionEventBasedAddonsChargebee.Subscriptions.SubscriptionItemTiers: Subscription ItemsSubscriptionItemTiersChargebee.Subscriptions.SubscriptionItems: Subscription ItemsSubscriptionItemsChargebee.Subscriptions.Subscriptions: SubscriptionsSubscriptionsChargebee.Customers.CustomersCChargebee.Coupons.Coupons: CouponsCouponsCouponChargebee.Gifts.Gifts: GiftsGiftsOrderChargebee.Plans.Plans: PlansPlansPlanInvoiceChargebee.Invoices.Installments: Installment ConfigurationsInstallmentsChargebee.Invoices.InvoiceAdjustmentCreditNotes: Invoice Adjustment Credit NotesInvoiceAdjustmentCreditNotesChargebee.Invoices.InvoiceAppliedCredits: Invoice Applied CreditsInvoiceAppliedCreditsChargebee.Invoices.InvoiceCreditNotes: Invoice Credit NotesInvoiceCreditNotesChargebee.Invoices.InvoiceDiscounts: Invoice DiscountsInvoiceDiscountsChargebee.Invoices.InvoiceDunningAttempts: Invoice Dunning AttemptsInvoiceDunningAttemptsChargebee.Invoices.InvoiceLineItemDiscounts: Invoice Line Item DiscountsInvoiceLineItemDiscountsChargebee.Invoices.InvoiceLineItemTaxes: Invoice Line Item TaxesInvoiceLineItemTaxesChargebee.Invoices.InvoiceLineItemTiers: Invoice Line Item TiersInvoiceLineItemTiersChargebee.Invoices.InvoiceLineItems: Invoice Line ItemsInvoiceLineItemsChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSChargebee.Invoices.InvoiceLinkedOrders: Invoice Linked OrdersInvoiceLinkedOrdersChargebee.Invoices.InvoiceLinkedPayments: Invoice Linked PaymentsInvoiceLinkedPaymentsChargebee.Invoices.InvoiceNotes: Invoice NotesInvoiceNotesChargebee.Invoices.InvoiceTaxes: Invoice TaxesInvoiceTaxesChargebee.Invoices.Invoices: InvoicesInvoicesChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSChargebee.Coupons.Coupons: CouponsCouponsCouponChargebee.Transactions.Transactions: Subscription Add-onsTransactionsTransactionChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSQuoteChargebee.Invoices.QuoteLineItemTiers: Quote Line Item TiersQuoteLineItemTiersChargebee.Quotes.QuoteDiscounts: Quote DiscountsQuoteDiscountsChargebee.Quotes.QuoteLineItemDiscounts: Quote Line Item DiscountsQuoteLineItemDiscountsChargebee.Quotes.QuoteLineItemTaxes: Quote Line Item TaxesQuoteLineItemTaxesChargebee.Quotes.QuoteLineItems: Quote Line ItemsQuoteLineItemsChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSChargebee.Quotes.QuoteNotes: Quote NotesQuoteNotesChargebee.Quotes.QuoteTaxes: Quote TaxesQuoteTaxesChargebee.Quotes.Quotes: QuotesQuotesChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSChargebee.Coupons.Coupons: CouponsCouponsCouponChargebee.Invoices.Invoices: InvoicesInvoicesInvoiceChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSCustomerChargebee.CreditNotes.CreditNotes: Credit NotesCreditNotesChargebee.Subscriptions.SubscriptionsSChargebee.Customers.Cards: CardsCardsChargebee.Customers.CustomerBalances: Customer BalancesCustomerBalancesChargebee.Customers.CustomerContacts: Customer ContactsCustomerContactsChargebee.Customers.CustomerCustomFieldValues: Customer Custom FieldsCustomerCustomFieldValuesChargebee.Customers.CustomerReferralUrls: Customer Referral URLsCustomerReferralUrlsChargebee.Customers.Customers: CustomersCustomersChargebee.PromotionalCredits.PromotionalCredits: Promotional CreditsPromotionalCreditsChargebee.UnbilledCharges.UnbilledCharges: Unbilled ChargesUnbilledChargesChargebee.Subscriptions.SubscriptionsSChargebee.VirtualBankAccounts.VirtualBankAccounts: Virtual Bank AccountsVirtualBankAccountsOrderChargebee.Gifts.GiftTimelines: Gift TimelinesGiftTimelinesChargebee.Gifts.Gifts: GiftsGiftsChargebee.Orders.OrderLineItemDiscounts: Order Line Item DiscountsOrderLineItemDiscountsChargebee.Orders.OrderLineItemTaxes: Order Line Item TaxesOrderLineItemTaxesChargebee.Orders.OrderLineItems: Order Line ItemsOrderLineItemsChargebee.Orders.OrderLinkedCreditNotes: Order Linked Credit NotesOrderLinkedCreditNotesChargebee.Orders.OrderResentOrders: Order Resent OrdersOrderResentOrdersChargebee.Orders.Orders: OrdersOrdersChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSChargebee.Coupons.Coupons: CouponsCouponsCouponChargebee.Invoices.Invoices: InvoicesInvoicesInvoiceChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSRampChargebee.Subscriptions.RampCouponsToAdd: Ramp Coupons to AddRampCouponsToAddChargebee.Subscriptions.RampCouponsToRemove: Ramp Coupons to RemoveRampCouponsToRemoveChargebee.Subscriptions.RampDiscountsToAdd: Ramp Discounts to AddRampDiscountsToAddChargebee.Subscriptions.RampDiscountsToRemove: Ramp Discounts to RemoveRampDiscountsToRemoveChargebee.Subscriptions.RampItemTiers: Ramp Item TiersRampItemTiersChargebee.Subscriptions.RampItemsToAdd: Ramp Items to AddRampItemsToAddChargebee.Subscriptions.RampItemsToRemove: Ramp Items to RemoveRampItemsToRemoveChargebee.Subscriptions.RampItemsToUpdate: Ramp Items to UpdateRampItemsToUpdateChargebee.Subscriptions.Ramps: RampsRampsChargebee.Subscriptions.SubscriptionsSChargebee.Coupons.Coupons: CouponsCouponsCouponCouponChargebee.Coupons.CouponAddons: Coupon Add-onsCouponAddonsChargebee.Coupons.CouponCodes: Coupon CodesCouponCodesChargebee.Coupons.CouponConstraints: Coupon ConstraintsCouponConstraintsChargebee.Coupons.CouponItemConstraintCriteria: Coupon Item Constraint CriteriaCouponItemConstraintCriteriaChargebee.Coupons.CouponItemConstraints: Coupon Item ConstraintsCouponItemConstraintsChargebee.Coupons.CouponPlans: Coupon PlansCouponPlansChargebee.Coupons.CouponSets: Coupon SetsCouponSetsChargebee.Coupons.Coupons: CouponsCouponsChargebee.Addons.Addons: Add-onsAddonsAddonChargebee.Plans.Plans: PlansPlansPlanPlanChargebee.Plans.PlanApplicableAddons: Plan Applicable Add-onsPlanApplicableAddonsChargebee.Plans.PlanAttachedAddons: Plan Attached Add-onsPlanAttachedAddonsChargebee.Plans.PlanCustomFieldValues: Plan Custom FieldsPlanCustomFieldValuesChargebee.Plans.PlanEventBasedAddons: Plan Event-based Add-onsPlanEventBasedAddonsChargebee.Plans.PlanTiers: Plan TiersPlanTiersChargebee.Plans.Plans: PlansPlansTransactionChargebee.Native.NATIVEPLATFORMSCALARREQUESTS: Native Platform Scalar RequestsNATIVEPLATFORMSCALARREQUESTSChargebee.Transactions.TransactionLinkedCreditNotes: Transaction Linked Credit NotesTransactionLinkedCreditNotesChargebee.Transactions.TransactionLinkedInvoices: Transaction Linked InvoicesTransactionLinkedInvoicesChargebee.Transactions.TransactionLinkedPayments: Transaction Linked PaymentsTransactionLinkedPaymentsChargebee.Transactions.TransactionLinkedRefunds: Transaction Linked RefundsTransactionLinkedRefundsChargebee.Transactions.Transactions: Subscription Add-onsTransactionsChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSChargebee.Invoices.Invoices: InvoicesInvoicesInvoiceChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSPaymentChargebee.Invoices.PaymentReferenceNumbers: Payment Reference NumbersPaymentReferenceNumbersChargebee.Subscriptions.PaymentSourceMandates: Payment Source MandatesPaymentSourceMandatesChargebee.Subscriptions.SubscriptionsSChargebee.Subscriptions.PaymentSources: Payment SourcesPaymentSourcesChargebee.Customers.CustomersCChargebee.Invoices.Invoices: InvoicesInvoicesInvoiceChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSOtherChargebee.Events.EventWebhooks: Event WebhooksEventWebhooksChargebee.Events.Events: EventsEventsChargebee.Items.ItemPrices: Item PricesItemPricesChargebee.Items.Items: ItemsItemsAddonChargebee.Addons.AddonCustomFieldValues: Addon Custom FieldsAddonCustomFieldValuesChargebee.Addons.AddonTiers: Add-on TiersAddonTiersChargebee.Addons.Addons: Add-onsAddonsChargebee.Invoices.Invoices: InvoicesInvoicesInvoiceChargebee.Customers.CustomersCChargebee.Subscriptions.SubscriptionsSPurchaseChargebee.Subscriptions.PurchaseInvoiceIDs: Purchase Invoice IDsPurchaseInvoiceIDsChargebee.Subscriptions.PurchaseSubscriptionIDs: Purchase Subscription IDsPurchaseSubscriptionIDsChargebee.Subscriptions.Purchases: PurchasesPurchasesChargebee.Customers.CustomersCBusinessChargebee.BusinessEntities.BusinessEntities: Business EntitiesBusinessEntitiesChargebee.BusinessEntities.BusinessEntityTransfers: Business Entity TransfersBusinessEntityTransfersCommentChargebee.Comments.Comments: CommentsCommentsCurrencyChargebee.Currencies.Currencies: CurrenciesCurrenciesCustomChargebee.CustomFields.CustomFieldConfigurations: Custom Field ConfigsCustomFieldConfigurationsHostedChargebee.HostedPages.HostedPageContents: Hosted Page ContentsHostedPageContentsChargebee.HostedPages.HostedPages: Hosted PagesHostedPagesInstallmentChargebee.Invoices.InstallmentConfigurations: Installment ConfigurationsInstallmentConfigurationsItemChargebee.Items.ItemFamilies: Item FamiliesItemFamiliesQuoteChargebee.Quotes.QuoteLineGroups: Quote Line GroupsQuoteLineGroupsSiteChargebee.SiteMigrationDetails.SiteMigrationDetails: Site Migration DetailsSiteMigrationDetailsUnbilledChargebee.UnbilledCharges.UnbilledChargeTiers: Unbilled Charge TiersUnbilledChargeTiersChargebeeAuthentication Authentication is done using an API key. An APIkey can be found and/or registered onhttps://SERVER/apikeys_and_webhooks/api. The API key is validfor a specific site. The Chargebee API key can be configured insettings.xml as the value of defaultPassword attribute of thedatabase element. The site is derived from the connectionNotesThis data model declares no keys yet; the dotted relations are derived from column names.Data dictionaryEvery table and column of this data model is described with its documentation ondocumentation.invantive.eu, where the poster is also available in other languages.NotesThe boxes are grouped by topic and coloured by category. A relation is drawn in the topic of thetable holding the key; a box in pale grey is defined in another topic.TopicsAddon1Coupon1Customer1Invoice1Order1Other1Payment1Plan1Purchase1Quote1Ramp1Subscription1Transaction1Tables without relations1LegendTransactionalSetupTechnicalHard-coded valuesDefined in another topicDeclared keyRelation described in wordsCandidate derived from column namesBold: a popular table+Bulk, +Read: the table also exists as these variants×n: n keys between the same tablesLetters: refers to a table used by most topics: C = Customers, S = SubscriptionsGenerated from the metadata of Invantive UniversalSQL 24.1.3-BETA+4689 on 10-06-2024. Every table links to itspage with columns, keys and sample queries.documentation.invantive.eu/en/datamodels/chargebee
The poster as text: tables per topic and their relations

Invoice

Installments, InvoiceAdjustmentCreditNotes, InvoiceAppliedCredits, InvoiceCreditNotes, InvoiceDiscounts, InvoiceDunningAttempts, InvoiceLineItemDiscounts, InvoiceLineItemTaxes, InvoiceLineItemTiers, InvoiceLineItems, InvoiceLinkedOrders, InvoiceLinkedPayments, InvoiceNotes, InvoiceTaxes, Invoices

Subscription

EntitlementOverrides, Entitlements, FeatureLevels, Features, SubscriptionEntitlements, SubscriptionAddons, SubscriptionChargedEventBasedAddons, SubscriptionChargedItems, SubscriptionCoupons, SubscriptionCustomFieldValues, SubscriptionDiscounts, SubscriptionEventBasedAddons, SubscriptionItemTiers, SubscriptionItems, Subscriptions

Customer

CreditNotes, Cards, CustomerBalances, CustomerContacts, CustomerCustomFieldValues, CustomerReferralUrls, Customers, PromotionalCredits, UnbilledCharges, VirtualBankAccounts

Ramp

RampCouponsToAdd, RampCouponsToRemove, RampDiscountsToAdd, RampDiscountsToRemove, RampItemTiers, RampItemsToAdd, RampItemsToRemove, RampItemsToUpdate, Ramps

Coupon

CouponAddons, CouponCodes, CouponConstraints, CouponItemConstraintCriteria, CouponItemConstraints, CouponPlans, CouponSets, Coupons

Order

GiftTimelines, Gifts, OrderLineItemDiscounts, OrderLineItemTaxes, OrderLineItems, OrderLinkedCreditNotes, OrderResentOrders, Orders

Quote

QuoteLineItemTiers, QuoteDiscounts, QuoteLineItemDiscounts, QuoteLineItemTaxes, QuoteLineItems, QuoteNotes, QuoteTaxes, Quotes

Plan

PlanApplicableAddons, PlanAttachedAddons, PlanCustomFieldValues, PlanEventBasedAddons, PlanTiers, Plans

Transaction

NATIVEPLATFORMSCALARREQUESTS, TransactionLinkedCreditNotes, TransactionLinkedInvoices, TransactionLinkedPayments, TransactionLinkedRefunds, Transactions

Other

EventWebhooks, Events, ItemPrices, Items

Addon

AddonCustomFieldValues, AddonTiers, Addons

Payment

PaymentReferenceNumbers, PaymentSourceMandates, PaymentSources

Purchase

PurchaseInvoiceIDs, PurchaseSubscriptionIDs, Purchases

Business (without relations)

BusinessEntities, BusinessEntityTransfers

Comment (without relations)

Comments

Currency (without relations)

Currencies

Custom (without relations)

CustomFieldConfigurations

Hosted (without relations)

HostedPageContents, HostedPages

Installment (without relations)

InstallmentConfigurations

Item (without relations)

ItemFamilies

Quote (without relations)

QuoteLineGroups

Site (without relations)

SiteMigrationDetails

Unbilled (without relations)

UnbilledChargeTiers

Relations

Tables

Chargebee.Addons

Chargebee.Addresses

Chargebee.BusinessEntities

Chargebee.Comments

Chargebee.Coupons

Chargebee.CreditNotes

Chargebee.Currencies

Chargebee.CustomFields

Chargebee.Customers

Chargebee.Entitlements

Chargebee.Events

Chargebee.Gifts

Chargebee.HostedPages

Chargebee.InAppPurchases

Chargebee.Invoices

Chargebee.Items

Chargebee.Native

Chargebee.Orders

Chargebee.Plans

Chargebee.PromotionalCredits

Chargebee.Quotes

Chargebee.SiteMigrationDetails

Chargebee.Subscriptions

Chargebee.Transactions

Chargebee.UnbilledCharges

Chargebee.VirtualBankAccounts

Attributes

The attributes of this platform are on the page Attributes.

Release Notes

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