Chargebee

This page contains the setup guide and reference information for the Chargebee source connector.

Prerequisites

To set up the Chargebee source connector, you'll need the Chargebee API key and the Product Catalog version.

Set up the Chargebee connector in Airbyte

1. Log into your Airbyte Cloud account or navigate to the Airbyte Open Source dashboard.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Chargebee from the Source type dropdown.
4. Enter the name for the Chargebee connector.
5. For Site, enter the site prefix for your Chargebee instance.
6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
7. For API Key, enter the Chargebee API key.
8. For Product Catalog, enter the Chargebee Product Catalog version.
9. Click Set up source.

Supported sync modes

The Chargebee source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append

Supported Streams

• Subscriptions
• Customers
• Invoices
• Orders
• Plans
• Addons
• Items
• Item Prices
• Attached Items

Some streams are available only for specific on Product Catalog versions:

1. Available in Product Catalog 1.0 and Product Catalog 2.0:
   • Customers
   • Events
   • Invoices
   • Credit Notes
   • Orders
   • Coupons
   • Subscriptions
   • Transactions
2. Available only in Product Catalog 1.0:
   • Plans
   • Addons
3. Available only in Product Catalog 2.0:
   • Items
   • Item Prices
   • Attached Items

Note that except the Attached Items stream, all the streams listed above are incremental streams, which means they:

• Read only new records
• Output only new records

The Attached Items stream is also incremental but it reads all records and outputs only new records, which is why syncing the Attached Items stream, even in incremental mode, is expensive in terms of your Chargebee API quota.

Generally speaking, it incurs a number of API calls equal to the total number of attached items in your chargebee instance divided by 100, regardless of how many AttachedItems were actually changed or synced in a particular sync job.

Performance considerations

The Chargebee connector should not run into Chargebee API limitations under normal usage. Create an issue if you encounter any rate limit issues that are not automatically retried successfully.

Changelog

Version	Date	Pull Request	Subject
0.2.4	2023-08-01	28905	Updated the connector to use latest CDK version
0.2.3	2023-03-22	24370	Ignore 404 errors for Contact stream
0.2.2	2023-02-17	21688	Migrate to CDK beta 0.29; fix schemas
0.2.1	2023-02-17	23207	Edited stream schemas to get rid of unnecessary enum
0.2.0	2023-01-21	21688	Migrate to YAML; add new streams
0.1.16	2022-10-06	17661	Make transaction stream to be consistent with S3 by using type transformer
0.1.15	2022-09-28	17304	Migrate to per-stream state.
0.1.14	2022-09-23	17056	Add "custom fields" to the relevant Chargebee source data streams
0.1.13	2022-08-18	15743	Fix transaction exchange_rate field type
0.1.12	2022-07-13	14672	Fix transaction sort by
0.1.11	2022-03-03	10827	Fix Credit Note stream
0.1.10	2022-03-02	10795	Add support for Credit Note stream
0.1.9	2022-0224	10312	Add support for Transaction Stream
0.1.8	2022-02-22	10366	Fix broken coupon stream + add unit tests
0.1.7	2022-02-14	10269	Add support for Coupon stream
0.1.6	2022-02-10	10143	Add support for Event stream
0.1.5	2021-12-23	8434	Update fields in source-connectors specifications
0.1.4	2021-09-27	6454	Fix examples in spec file
0.1.3	2021-08-17	5421	Add support for "Product Catalog 2.0" specific streams: Items, Item prices and Attached Items
0.1.2	2021-07-30	5067	Prepare connector for publishing
0.1.1	2021-07-07	4539	Add entrypoint and bump version for connector
0.1.0	2021-06-30	3410	New Source: Chargebee