Skip to main content


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


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:

Supported Streams

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.


VersionDatePull RequestSubject
0.2.32023-03-2224370Ignore 404 errors for Contact stream
0.2.22023-02-1721688Migrate to CDK beta 0.29; fix schemas
0.2.12023-02-1723207Edited stream schemas to get rid of unnecessary enum
0.2.02023-01-2121688Migrate to YAML; add new streams
0.1.162022-10-0617661Make transaction stream to be consistent with S3 by using type transformer
0.1.152022-09-2817304Migrate to per-stream state.
0.1.142022-09-2317056Add "custom fields" to the relevant Chargebee source data streams
0.1.132022-08-1815743Fix transaction exchange_rate field type
0.1.122022-07-1314672Fix transaction sort by
0.1.112022-03-0310827Fix Credit Note stream
0.1.102022-03-0210795Add support for Credit Note stream
0.1.92022-022410312Add support for Transaction Stream
0.1.82022-02-2210366Fix broken coupon stream + add unit tests
0.1.72022-02-1410269Add support for Coupon stream
0.1.62022-02-1010143Add support for Event stream
0.1.52021-12-238434Update fields in source-connectors specifications
0.1.42021-09-276454Fix examples in spec file
0.1.32021-08-175421Add support for "Product Catalog 2.0" specific streams: Items, Item prices and Attached Items
0.1.22021-07-305067Prepare connector for publishing
0.1.12021-07-074539Add entrypoint and bump version for connector
0.1.02021-06-303410New Source: Chargebee