January 2025

Schema changes

Chargebee Product Catalog 1.0

Effective January 3, 2025 we use a new January 2025 schema. Review the latest ERD to better understand the schema changes. Also, see our Schema Migrations article for more details.

We are making these schema changes to introduce feature enhancements and improve schema usability.

You should review the changes and update your downstream queries if necessary. Failing to do so may lead to missing or incomplete data in your data pipelines.

125 total changes • 64 possible breaking changes

Table/column	Change type	Old name	New name	Notes
`ADDON`
column	Rename Column	`accounting_category1`	`accounting_category_1`
column	Rename Column	`accounting_category2`	`accounting_category_2`
column	Rename Column	`accounting_category3`	`accounting_category_3`
column	Rename Column	`accounting_category4`	`accounting_category_4`
column	New Column		`proration_type`
`ADDON_TAX_PROVIDER_FIELD`
table	New Table		`ADDON_TAX_PROVIDER_FIELD`
`ADDON_TIER`
table	New Table		`ADDON_TIER`
`CREDIT_NOTE_DISCOUNT`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`credit_note_id`	`credit_note_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`CREDIT_NOTE_LINE_ITEM`
table	New Table
`CREDIT_NOTE_LINE_ITEM_DISCOUNT`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`credit_note_id`	`credit_note_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`CREDIT_NOTE_LINE_ITEM_TAX`
table	New Table
`CREDIT_NOTE_LINE_ITEM_TIER`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`credit_note_id`	`credit_note_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`CREDIT_NOTE_TAX`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`credit_note_id`	`credit_note_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`CUSTOMER_BALANCE`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`customer_id`	`customer_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`CUSTOMER_TAX_PROVIDER_FIELD`
table	New Table		`CUSTOMER_TAX_PROVIDER_FIELD`
`EVENT`
table	New Table		`EVENT`
`EVENT_METADATA`
table	New Table		`EVENT_METADATA`
`EVENT_WEBHOOK`
table	New Table		`EVENT_WEBHOOK`
`GIFT_TIMELINE`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`gift_id`	`gift_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`HOSTED_PAGE`
column	New Column		`business_entity_id`
`INVOICE`
column	New Column		`einvoice_reference_number`
column	New Column		`local_currency_exchange_rate`
column	New Column		`site_details_at_creation_organization_address_city`
column	New Column		`site_details_at_creation_organization_address_country_code`
column	New Column		`site_details_at_creation_organization_address_line_1`
column	New Column		`site_details_at_creation_organization_address_state`
column	New Column		`site_details_at_creation_organization_address_zip`
column	New Column		`site_details_at_creation_organization_email`
column	New Column		`site_details_at_creation_organization_name`
column	New Column		`site_details_at_creation_organization_phone`
column	New Column		`site_details_at_creation_organization_website`
column	New Column		`site_details_at_creation_timezone`
column	New Column		`statement_descriptor`
column	New Column		`statement_descriptor_id`
column	New Column		`tax_category`
column	New Column		`tax_origin_country`
column	New Column		`tax_origin_registration_number`
`INVOICE_DISCOUNT`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`invoice_id`	`invoice_id` 🔑	Added to primary key.
column	Primary Key Change	`invoice_updated_at`	`invoice_updated_at` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`INVOICE_DUNNING_ATTEMPT`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`invoice_id`	`invoice_id` 🔑	Added to primary key.
column	Primary Key Change	`invoice_updated_at`	`invoice_updated_at` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`INVOICE_LINE_ITEM`
table	New Table
`INVOICE_LINE_ITEM_DISCOUNT`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`invoice_id`	`invoice_id` 🔑	Added to primary key.
column	Primary Key Change	`invoice_updated_at`	`invoice_updated_at` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`INVOICE_LINE_ITEM_TAX`
table	New Table
`INVOICE_NOTE`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`invoice_id`	`invoice_id` 🔑	Added to primary key.
column	Primary Key Change	`invoice_updated_at`	`invoice_updated_at` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`INVOICE_TAX`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`invoice_id`	`invoice_id` 🔑	Added to primary key.
column	Primary Key Change	`invoice_updated_at`	`invoice_updated_at` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`LINE_ITEM`
table	Discontinued Table	`LINE_ITEM`		Data now available in the `INVOICE_LINE_ITEM`, `QUOTE_LINE_ITEM`, and `CREDIT_NOTE_LINE_ITEM` tables.
`LINE_ITEM_TAX`
table	Discontinued Table	`LINE_ITEM_TAX`		Data now available in the `INVOICE_LINE_ITEM_TAX`, `CREDIT_NOTE_LINE_ITEM_TAX`, `QUOTE_LINE_ITEM_TAX`, and `ORDER_LINE_ITEM_TAX` tables.
`ORDER_LINE_ITEM_DISCOUNT`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`order_id`	`order_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`ORDER_LINE_ITEM_TAX`
table	New Table	`_FIVETRAN_ID` 🔑		No longer primary key.
`PAYMENT_SOURCE`
column	New Column		`bank_account_direct_debit_scheme`
column	New Column		`boleto_email`
column	New Column		`boleto_first_name`
column	New Column		`boleto_last_4`
column	New Column		`boleto_last_name`
column	New Column		`klarna_pay_now_email`
column	New Column		`venmo_user_name`
`PLAN`
column	Rename Column	`accounting_category1`	`accounting_category_1`
column	Rename Column	`accounting_category2`	`accounting_category_2`
column	Rename Column	`accounting_category3`	`accounting_category_3`
column	Rename Column	`accounting_category4`	`accounting_category_4`
`PLAN_TAX_PROVIDER_FIELD`
table	New Table		`PLAN_TAX_PROVIDER_FIELD`
`PLAN_TIER`
table	New Table		`PLAN_TIER`
`QUOTE_DISCOUNT`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`quote_id`	`quote_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`QUOTE_LINE_ITEM`
table	New Table
`QUOTE_LINE_ITEM_DISCOUNT`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`quote_id`	`quote_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`QUOTE_LINE_ITEM_TAX`
table	New Table
`QUOTE_LINE_ITEM_TIER`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`quote_id`	`quote_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`QUOTE_TAX`
column	Discontinued Column	`_fivetran_id` 🔑		No longer primary key.
column	Primary Key Change	`quote_id`	`quote_id` 🔑	Added to primary key.
column	Primary Key Change		`index` 🔑	New primary key.
`SUBSCRIPTION`
column	New Column		`contract_term_total_contract_value_before_tax`
`TIER`
table	Discontinued Table	`TIER`		Data now available in the `UNBILLED_CHARGE_TIER`, `ADDON_TIER`, and `PLAN_TIER` tables.
`TRANSACTION`
column	New Column		`custom_payment_method_id`
column	New Column		`custom_payment_method_name`
column	New Column		`error_cause_customer_message`
column	New Column		`error_cause_id`
column	New Column		`error_cause_merchant_message`
column	New Column		`error_detail_decline_code`
column	New Column		`error_detail_decline_message`
column	New Column		`error_detail_error_category`
column	New Column		`error_detail_error_code`
column	New Column		`error_detail_error_field`
column	New Column		`error_detail_error_message`
column	New Column		`error_detail_network_error_code`
column	New Column		`error_detail_network_error_message`
column	New Column		`error_detail_processor_error_code`
column	New Column		`error_detail_processor_error_message`
column	New Column		`error_detail_recommendation_code`
column	New Column		`error_detail_recommendation_message`
column	New Column		`error_detail_request_id`
`UNBILLED_CHARGE_TIER`
table	New Table		`UNBILLED_CHARGE_TIER`

Improvements

File connectors

We have renamed the Folder Path field to Base folder path in the following connector setup forms:

New connectors created on or after January 2, 2025, will have this change. We are gradually rolling it out to all existing connectors.

Google Drive

We have renamed the Folder URL field to Base folder URL in the connector setup form. New connectors created on or after January 2, 2025, will have this change.

We are gradually rolling out these changes to all existing connectors.