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.
On a table of the poster: plus and minus zoom, the arrow keys move, 0 fits.
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)
Currency (without relations)
Custom (without relations)
Hosted (without relations)
HostedPageContents, HostedPages
Installment (without relations)
Item (without relations)
Quote (without relations)
Site (without relations)
Unbilled (without relations)
Relations
- AddonCustomFieldValues → Invoices (candidate): Derived from the column invoice_id.
- AddonTiers → Addons (candidate): Derived from the column addon_id.
- CouponAddons → Addons (candidate): Derived from the column addon_id.
- CouponAddons → Coupons (candidate): Derived from the column coupon_id.
- CouponCodes → Coupons (candidate): Derived from the column coupon_id.
- CouponConstraints → Coupons (candidate): Derived from the column coupon_id.
- CouponItemConstraintCriteria → Coupons (candidate): Derived from the column coupon_id.
- CouponItemConstraints → Coupons (candidate): Derived from the column coupon_id.
- CouponPlans → Coupons (candidate): Derived from the column coupon_id.
- CouponPlans → Plans (candidate): Derived from the column plan_id.
- CouponSets → Coupons (candidate): Derived from the column coupon_id.
- CreditNotes → Customers (candidate): Derived from the column customer_id.
- CreditNotes → Subscriptions (candidate): Derived from the column subscription_id.
- Cards → Customers (candidate): Derived from the column customer_id.
- CustomerBalances → Customers (candidate): Derived from the column customer_id.
- CustomerContacts → Customers (candidate): Derived from the column customer_id.
- CustomerCustomFieldValues → Customers (candidate): Derived from the column customer_id.
- CustomerReferralUrls → Customers (candidate): Derived from the column customer_id.
- EntitlementOverrides → Features (candidate): Derived from the column feature_id.
- Entitlements → Features (candidate): Derived from the column feature_id.
- FeatureLevels → Features (candidate): Derived from the column feature_id.
- SubscriptionEntitlements → Features (candidate): Derived from the column feature_id.
- SubscriptionEntitlements → Subscriptions (candidate): Derived from the column subscription_id.
- EventWebhooks → Events (candidate): Derived from the column event_id.
- GiftTimelines → Gifts (candidate): Derived from the column gift_id.
- Installments → Invoices (candidate): Derived from the column invoice_id.
- InvoiceAdjustmentCreditNotes → Invoices (candidate): Derived from the column invoice_id.
- InvoiceAppliedCredits → Invoices (candidate): Derived from the column invoice_id.
- InvoiceCreditNotes → Invoices (candidate): Derived from the column invoice_id.
- InvoiceDiscounts → Invoices (candidate): Derived from the column invoice_id.
- InvoiceDunningAttempts → Invoices (candidate): Derived from the column invoice_id.
- InvoiceDunningAttempts → Transactions (candidate): Derived from the column transaction_id.
- InvoiceLineItemDiscounts → Coupons (candidate): Derived from the column coupon_id.
- InvoiceLineItemDiscounts → Invoices (candidate): Derived from the column invoice_id.
- InvoiceLineItemTaxes → Invoices (candidate): Derived from the column invoice_id.
- InvoiceLineItemTiers → Invoices (candidate): Derived from the column invoice_id.
- InvoiceLineItems → Customers (candidate): Derived from the column customer_id.
- InvoiceLineItems → Invoices (candidate): Derived from the column invoice_id.
- InvoiceLineItems → Subscriptions (candidate): Derived from the column subscription_id.
- InvoiceLinkedOrders → Invoices (candidate): Derived from the column invoice_id.
- InvoiceLinkedPayments → Invoices (candidate): Derived from the column invoice_id.
- InvoiceNotes → Invoices (candidate): Derived from the column invoice_id.
- InvoiceTaxes → Invoices (candidate): Derived from the column invoice_id.
- Invoices → Customers (candidate): Derived from the column customer_id.
- Invoices → Subscriptions (candidate): Derived from the column subscription_id.
- PaymentReferenceNumbers → Invoices (candidate): Derived from the column invoice_id.
- QuoteLineItemTiers → Quotes (candidate): Derived from the column quote_id.
- ItemPrices → Items (candidate): Derived from the column item_id.
- NATIVEPLATFORMSCALARREQUESTS → Transactions (candidate): Derived from the column TRANSACTION_ID.
- OrderLineItemDiscounts → Coupons (candidate): Derived from the column coupon_id.
- OrderLineItemDiscounts → Orders (candidate): Derived from the column order_id.
- OrderLineItemTaxes → Orders (candidate): Derived from the column order_id.
- OrderLineItems → Invoices (candidate): Derived from the column invoice_id.
- OrderLineItems → Orders (candidate): Derived from the column order_id.
- OrderLinkedCreditNotes → Orders (candidate): Derived from the column order_id.
- OrderResentOrders → Orders (candidate): Derived from the column order_id.
- Orders → Customers (candidate): Derived from the column customer_id.
- Orders → Gifts (candidate): Derived from the column gift_id.
- Orders → Invoices (candidate): Derived from the column invoice_id.
- Orders → Subscriptions (candidate): Derived from the column subscription_id.
- PlanApplicableAddons → Plans (candidate): Derived from the column plan_id.
- PlanAttachedAddons → Plans (candidate): Derived from the column plan_id.
- PlanCustomFieldValues → Plans (candidate): Derived from the column plan_id.
- PlanEventBasedAddons → Plans (candidate): Derived from the column plan_id.
- PlanTiers → Plans (candidate): Derived from the column plan_id.
- PromotionalCredits → Customers (candidate): Derived from the column customer_id.
- QuoteDiscounts → Quotes (candidate): Derived from the column quote_id.
- QuoteLineItemDiscounts → Coupons (candidate): Derived from the column coupon_id.
- QuoteLineItemDiscounts → Quotes (candidate): Derived from the column quote_id.
- QuoteLineItemTaxes → Quotes (candidate): Derived from the column quote_id.
- QuoteLineItems → Customers (candidate): Derived from the column customer_id.
- QuoteLineItems → Quotes (candidate): Derived from the column quote_id.
- QuoteLineItems → Subscriptions (candidate): Derived from the column subscription_id.
- QuoteNotes → Quotes (candidate): Derived from the column quote_id.
- QuoteTaxes → Quotes (candidate): Derived from the column quote_id.
- Quotes → Customers (candidate): Derived from the column customer_id.
- Quotes → Invoices (candidate): Derived from the column invoice_id.
- Quotes → Subscriptions (candidate): Derived from the column subscription_id.
- PaymentSourceMandates → Invoices (candidate): Derived from the column invoice_id.
- PaymentSourceMandates → Subscriptions (candidate): Derived from the column subscription_id.
- PaymentSources → Customers (candidate): Derived from the column customer_id.
- PurchaseInvoiceIDs → Purchases (candidate): Derived from the column purchase_id.
- PurchaseSubscriptionIDs → Purchases (candidate): Derived from the column purchase_id.
- Purchases → Customers (candidate): Derived from the column customer_id.
- RampCouponsToAdd → Coupons (candidate): Derived from the column coupon_id.
- RampCouponsToAdd → Ramps (candidate): Derived from the column ramp_id.
- RampCouponsToRemove → Ramps (candidate): Derived from the column ramp_id.
- RampDiscountsToAdd → Ramps (candidate): Derived from the column ramp_id.
- RampDiscountsToRemove → Ramps (candidate): Derived from the column ramp_id.
- RampItemTiers → Ramps (candidate): Derived from the column ramp_id.
- RampItemsToAdd → Ramps (candidate): Derived from the column ramp_id.
- RampItemsToRemove → Ramps (candidate): Derived from the column ramp_id.
- RampItemsToUpdate → Ramps (candidate): Derived from the column ramp_id.
- Ramps → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionAddons → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionChargedEventBasedAddons → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionChargedItems → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionCoupons → Coupons (candidate): Derived from the column coupon_id.
- SubscriptionCoupons → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionCustomFieldValues → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionDiscounts → Coupons (candidate): Derived from the column coupon_id.
- SubscriptionDiscounts → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionEventBasedAddons → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionItemTiers → Subscriptions (candidate): Derived from the column subscription_id.
- SubscriptionItems → Subscriptions (candidate): Derived from the column subscription_id.
- Subscriptions → Customers (candidate): Derived from the column customer_id.
- Subscriptions → Gifts (candidate): Derived from the column gift_id.
- Subscriptions → Plans (candidate): Derived from the column plan_id.
- TransactionLinkedCreditNotes → Transactions (candidate): Derived from the column transaction_id.
- TransactionLinkedInvoices → Invoices (candidate): Derived from the column invoice_id.
- TransactionLinkedInvoices → Transactions (candidate): Derived from the column transaction_id.
- TransactionLinkedPayments → Transactions (candidate): Derived from the column transaction_id.
- TransactionLinkedRefunds → Transactions (candidate): Derived from the column transaction_id.
- Transactions → Customers (candidate): Derived from the column customer_id.
- Transactions → Subscriptions (candidate): Derived from the column subscription_id.
- UnbilledCharges → Customers (candidate): Derived from the column customer_id.
- UnbilledCharges → Subscriptions (candidate): Derived from the column subscription_id.
- VirtualBankAccounts → Customers (candidate): Derived from the column customer_id.
Tables
Chargebee.Addons
- AddonCustomFieldValues: Addon Custom Fields
- AddonTiers: Add-on Tiers
- Addons: Add-ons
Chargebee.Addresses
- Addresses: Addresses
Chargebee.BusinessEntities
- BusinessEntities: Business Entities
- BusinessEntityTransfers: Business Entity Transfers
Chargebee.Comments
- Comments: Comments
Chargebee.Coupons
- CouponAddons: Coupon Add-ons
- CouponCodes: Coupon Codes
- CouponConstraints: Coupon Constraints
- CouponItemConstraintCriteria: Coupon Item Constraint Criteria
- CouponItemConstraints: Coupon Item Constraints
- CouponPlans: Coupon Plans
- CouponSets: Coupon Sets
- Coupons: Coupons
Chargebee.CreditNotes
- CreditNotes: Credit Notes
Chargebee.Currencies
- Currencies: Currencies
Chargebee.CustomFields
- CustomFieldConfigurations: Custom Field Configs
Chargebee.Customers
- Cards: Cards
- CustomerBalances: Customer Balances
- CustomerContacts: Customer Contacts
- CustomerCustomFieldValues: Customer Custom Fields
- CustomerReferralUrls: Customer Referral URLs
- Customers: Customers
Chargebee.Entitlements
- EntitlementOverrides: Entitlement Overrides
- Entitlements: Entitlements
- FeatureLevels: Feature Levels
- Features: Features
- SubscriptionEntitlements: Subscription Entitlements
Chargebee.Events
- EventWebhooks: Event Webhooks
- Events: Events
Chargebee.Gifts
- GiftTimelines: Gift Timelines
- Gifts: Gifts
Chargebee.HostedPages
- HostedPageContents: Hosted Page Contents
- HostedPages: Hosted Pages
Chargebee.InAppPurchases
- InAppSubscriptionsById: In App Subscriptions
Chargebee.Invoices
- InstallmentConfigurations: Installment Configurations
- Installments: Installment Configurations
- InvoiceAdjustmentCreditNotes: Invoice Adjustment Credit Notes
- InvoiceAppliedCredits: Invoice Applied Credits
- InvoiceCreditNotes: Invoice Credit Notes
- InvoiceDiscounts: Invoice Discounts
- InvoiceDunningAttempts: Invoice Dunning Attempts
- InvoiceLineItemDiscounts: Invoice Line Item Discounts
- InvoiceLineItemTaxes: Invoice Line Item Taxes
- InvoiceLineItemTiers: Invoice Line Item Tiers
- InvoiceLineItems: Invoice Line Items
- InvoiceLinkedOrders: Invoice Linked Orders
- InvoiceLinkedPayments: Invoice Linked Payments
- InvoiceNotes: Invoice Notes
- InvoicePdfById: Invoice as PDF
- InvoiceTaxes: Invoice Taxes
- Invoices: Invoices
- PaymentReferenceNumbers: Payment Reference Numbers
- QuoteLineItemTiers: Quote Line Item Tiers
Chargebee.Items
- ItemFamilies: Item Families
- ItemPrices: Item Prices
- Items: Items
Chargebee.Native
- NATIVEPLATFORMSCALARREQUESTS: Native Platform Scalar Requests
Chargebee.Orders
- OrderLineItemDiscounts: Order Line Item Discounts
- OrderLineItemTaxes: Order Line Item Taxes
- OrderLineItems: Order Line Items
- OrderLinkedCreditNotes: Order Linked Credit Notes
- OrderResentOrders: Order Resent Orders
- Orders: Orders
Chargebee.Plans
- PlanApplicableAddons: Plan Applicable Add-ons
- PlanAttachedAddons: Plan Attached Add-ons
- PlanCustomFieldValues: Plan Custom Fields
- PlanEventBasedAddons: Plan Event-based Add-ons
- PlanTiers: Plan Tiers
- Plans: Plans
Chargebee.PromotionalCredits
- PromotionalCredits: Promotional Credits
Chargebee.Quotes
- QuoteDiscounts: Quote Discounts
- QuoteLineGroups: Quote Line Groups
- QuoteLineItemDiscounts: Quote Line Item Discounts
- QuoteLineItemTaxes: Quote Line Item Taxes
- QuoteLineItems: Quote Line Items
- QuoteNotes: Quote Notes
- QuoteTaxes: Quote Taxes
- Quotes: Quotes
Chargebee.SiteMigrationDetails
- SiteMigrationDetails: Site Migration Details
Chargebee.Subscriptions
- PaymentSourceMandates: Payment Source Mandates
- PaymentSources: Payment Sources
- PurchaseInvoiceIDs: Purchase Invoice IDs
- PurchaseSubscriptionIDs: Purchase Subscription IDs
- Purchases: Purchases
- RampCouponsToAdd: Ramp Coupons to Add
- RampCouponsToRemove: Ramp Coupons to Remove
- RampDiscountsToAdd: Ramp Discounts to Add
- RampDiscountsToRemove: Ramp Discounts to Remove
- RampItemTiers: Ramp Item Tiers
- RampItemsToAdd: Ramp Items to Add
- RampItemsToRemove: Ramp Items to Remove
- RampItemsToUpdate: Ramp Items to Update
- Ramps: Ramps
- SubscriptionAddons: Subscription Add-ons
- SubscriptionChargedEventBasedAddons: Subscription-charged Event-based Add-ons
- SubscriptionChargedItems: Subscription Items
- SubscriptionCoupons: Subscription Coupons
- SubscriptionCustomFieldValues: Subscription Custom Fields
- SubscriptionDiscounts: Subscription Items
- SubscriptionEventBasedAddons: Subscription Event-based Add-ons
- SubscriptionItemTiers: Subscription Items
- SubscriptionItems: Subscription Items
- Subscriptions: Subscriptions
- UsagesBySubscriptionID: Usages by Subscription ID
Chargebee.Transactions
- TransactionLinkedCreditNotes: Transaction Linked Credit Notes
- TransactionLinkedInvoices: Transaction Linked Invoices
- TransactionLinkedPayments: Transaction Linked Payments
- TransactionLinkedRefunds: Transaction Linked Refunds
- Transactions: Subscription Add-ons
Chargebee.UnbilledCharges
- UnbilledChargeTiers: Unbilled Charge Tiers
- UnbilledCharges: Unbilled Charges
Chargebee.VirtualBankAccounts
- VirtualBankAccounts: Virtual Bank Accounts
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: