Advanced Analytica Advanced Analytica: IBOM
← All connectors
Chargebee logo

Source connector

Chargebee

Set up Chargebee as a source and move its data into your chosen destination.

Version 0.11.3 certified generally available

Chargebee

Use this page to set up the Chargebee source connector and find reference information.

Prerequisites

Before you set up the Chargebee source connector, you need:

  • A Chargebee API key with read access. You can use either a full-access or read-only key.
  • Your Chargebee site name. This is the subdomain in your Chargebee URL. For example, if your dashboard URL is https://acme.chargebee.com, your site name is acme.
  • The Product Catalog version of your Chargebee site.

:::info Chargebee sites created after May 5, 2021 use Product Catalog 2.0 by default. Sites created before this date use Product Catalog 1.0. Check your version in the API Version section of the Chargebee API docs. :::

Set up Chargebee in Airbyte

  1. Log into your Airbyte Cloud account or go to the Airbyte Open Source dashboard.
  2. Click Sources, then click + New source.
  3. On the Set up the source page, select Chargebee from the Source type dropdown.
  4. Enter a name for the Chargebee connector.
  5. For Site, enter your Chargebee instance’s site prefix. For example, if your Chargebee URL is https://acme.chargebee.com, enter acme.
  6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The connector only replicates data created or updated on or after this date.
  7. For API Key, enter your Chargebee API key.
  8. For Product Catalog, select your Chargebee Product Catalog version. The connector defaults to Product Catalog 2.0.
  9. Optionally, adjust the Number of concurrent threads to control the worker threads used during syncs. The default is 5. Higher values can increase throughput, but also consume more of your Chargebee API rate limit.
  10. Click Set up source.

Supported sync modes

The Chargebee source connector supports these sync modes:

Supported streams

Most streams support every Chargebee site Product Catalog version, with a few version-specific exceptions.

StreamProduct Catalog 1.0Product Catalog 2.0
Addons✔
Attached Items✔
Comments✔✔
Contacts✔✔
Coupons✔✔
Credit Notes✔✔
Customers✔✔
Differential Prices✔✔
Events✔✔
Gifts✔✔
Hosted Pages✔✔
Invoices✔✔
Items✔
Item Prices✔
Item Families✔
Orders✔✔
Payment Sources✔✔
Plans✔
Promotional Credits✔✔
Quotes✔✔
Quote Line Groups✔✔
Site Migration Details✔✔
Subscriptions✔✔
Subscriptions With Scheduled Changes✔✔
Transactions✔✔
Unbilled Charges✔✔
Virtual Bank Accounts✔✔

:::note In incremental sync mode, the Attached Items stream lists all parent Items during every sync. It makes one attached-items request for each item. However, it only fetches attached items whose updated_at changed since the previous sync. The first sync reads all attached items belonging to items updated on or after the start date.

Incremental sync has two limitations for this stream:

  • Deleting an attached item in Chargebee doesn’t remove its destination record. A full refresh with overwrite replaces the stream’s data and removes the record.
  • The connector doesn’t read an item last updated before the start date as a parent. If updated later, it only fetches attached items changed since the previous sync. Therefore, its older attached items are never synced. To prevent this, set an earlier start date or periodically run a full refresh for the stream.

:::

Limitations and troubleshooting

Rate limits

Under normal usage, the Chargebee connector shouldn’t encounter Chargebee API limitations. It automatically retries rate-limited requests using the Chargebee API’s Retry-After header. See Create an issue if rate-limited requests aren’t retried successfully.

Chargebee API rate limits vary by plan. Test sites are limited to 150 requests per minute, regardless of plan. See Chargebee’s API limits documentation for details.

Deleted resources

The Chargebee API may return HTTP 404 errors for references to deleted resources. These include subscriptions linked to removed plans or items. The connector skips the unavailable resource and continues the sync. This applies to the Contacts, Subscriptions, Subscriptions With Scheduled Changes, and Quote Line Groups streams.

Product Catalog version mismatch

Some streams are only available for a specific Product Catalog version. The connector skips streams that aren’t compatible with your site’s Product Catalog version. It then logs: “Stream is available only for Product Catalog 1.0” or the equivalent for Product Catalog 2.0.

Troubleshooting

  • Find common Chargebee source connector issues on the Airbyte Forum.

IP allow list

If you use Airbyte Cloud and restrict access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Changelog

Expand to review
VersionDatePull RequestSubject
0.11.32026-11-1190376Consolidate per-stream error handling into a single handler; retryable errors (including HTTP 429) now retry up to 10 times instead of 5
0.11.22026-11-1091456Update dependencies
0.11.12026-11-0390509Update dependencies
0.11.02026-10-3089003Add incremental sync support to the attached_item stream
0.10.532026-10-2789839Update dependencies
0.10.522026-10-2089159Update dependencies
0.10.512026-10-1388525Update dependencies
0.10.502026-10-0687801Update dependencies
0.10.492026-09-2987111Update dependencies
0.10.482026-09-2286576Update dependencies
0.10.472026-09-1585980Update dependencies
0.10.462026-09-0885441Update dependencies
0.10.452026-08-1884510Update dependencies
0.10.442026-08-1183885Update dependencies
0.10.432026-07-2883194Update to CDK 7.23.8 (fixes AirbyteCustomCodeNotPermittedError for bundled custom components) and remove the temporary Cloud version override
0.10.422026-07-281082Roll Cloud back to 0.10.40 — 0.10.41 is built on SDM 7.23.7, which breaks bundled custom components
0.10.412026-07-2882863Update dependencies
0.10.402026-07-2181761Update dependencies
0.10.392026-06-3081013Update dependencies
0.10.382026-06-2380404Update dependencies
0.10.372026-06-1678619Update dependencies
0.10.362026-06-0979604Clean up cancelled RC; revert source to previous stable
0.10.36-rc.52026-05-2778469Remove the local API budget limiter while keeping the default worker count at 5.
0.10.36-rc.42026-05-2678435Reduce default concurrent threads to 3 after rollout duration regressions at 5.
0.10.36-rc.32026-05-2278366Revert default_concurrency to 5, activate tier-aware HTTPAPIBudget, and document subscription_tier for GA rollout
0.10.36-rc.22026-05-2078300Raise default_concurrency to 6 after Phase 1 monitoring of 0.10.36-rc.1 showed no rate-limit signal and faster high-volume sync averages excluding a stable-precedent multi-attempt outlier
0.10.36-rc.12026-05-1874345Raise default_concurrency to 5 (Path B tuning calibrated to the Chargebee Starter tier, 150 req/min = 2.5 req/sec); bump num_workers minimum to 2 and default to 5; add subscription_tier spec field (enum starter/performance/enterprise, default starter); record original Starter and tier-aware HTTPAPIBudget shapes as YAML comments for activation in a follow-up GA RC; enable progressive rollout
0.10.352026-04-2877207Update dependencies
0.10.342026-04-2175795Update dependencies
0.10.332026-04-1376276Rename “concurrent workers” to “concurrent threads” in connector spec
0.10.322026-03-2675476Handle 404 errors in subscription stream to prevent sync failures when Chargebee returns not found for deleted resources
0.10.312026-03-2474459Update dependencies
0.10.302026-03-0374228Update dependencies
0.10.292026-02-1773452Update dependencies
0.10.282026-02-1072990Update dependencies
0.10.272026-01-2072117Update dependencies
0.10.262026-01-1471716Update dependencies
0.10.252025-12-1870665Update dependencies
0.10.242025-11-2569940Update dependencies
0.10.232025-11-1869621Update dependencies
0.10.222025-10-2968902Update dependencies
0.10.212025-10-2168546Update dependencies
0.10.202025-10-1468083Update dependencies
0.10.192025-10-0767181Update dependencies
0.10.182025-09-3065793Update dependencies
0.10.172025-09-1065996Update to CDK v7
0.10.162025-08-2365294Update dependencies
0.10.152025-08-0964707Update dependencies
0.10.142025-08-0463936Fix missing data in subscriptions with scheduled changes stream
0.10.132025-08-0264333Update dependencies
0.10.122025-07-2664039Update dependencies
0.10.112025-07-1963538Update dependencies
0.10.102025-07-1263022Update dependencies
0.10.92025-06-2862369Update dependencies
0.10.82025-06-2161985Update dependencies
0.10.72025-06-1459347Update dependencies
0.10.62025-04-2658729Update dependencies
0.10.52025-04-1957648Update dependencies
0.10.42025-04-0557130Update dependencies
0.10.32025-03-2956138Update dependencies
0.10.22025-03-1755799Adding the new field discount_quantity to stream coupon
0.10.12025-03-0851760Update dependencies
0.10.02025-02-2054182Promoting release candidate 0.10.0-rc.1 to a main version.
0.10.0-rc.12025-07-0253220Replace custom IncrementalSingleSliceCursor component with low-code semi-incremental DatetimeBasedCursor
0.9.02025-02-0647243Migrate to Manifest-only
0.8.02025-01-3152685Update to latest CDK version
0.7.32025-01-1149038Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.7.22024-11-2048510Ensure no pagination issues on concurrent syncs
0.7.12024-11-0448133Fix error message pattern to handle Product 1.0 related errors
0.7.02024-10-3047978Upgrade the CDK and startup files to sync incremental streams concurrently
0.6.182024-10-3147099Update dependencies
0.6.172024-10-2847387Update CDK dependencies to yield parent records more frequently
0.6.162024-10-1246846Update dependencies
0.6.152024-10-0546478Update dependencies
0.6.142024-10-0346343Added incremental dependency for substreams with Incremental parent streams
0.6.132024-10-0146294Update CDK version to ^5, increased the maxSecondsBetweenMessages to 6 hours
0.6.122024-09-2846169Update dependencies
0.6.112024-09-2145805Update dependencies
0.6.102024-09-1445254Update dependencies
0.6.92024-08-3145028Update dependencies
0.6.82024-08-2444662Update dependencies
0.6.72024-08-1744265Update dependencies
0.6.62024-08-1043640Update dependencies
0.6.52024-08-0343081Update dependencies
0.6.42024-07-2742626Update dependencies
0.6.32024-07-2042296Update dependencies
0.6.22024-07-1341691Update dependencies
0.6.12024-07-1041113Update dependencies
0.6.02024-07-1039217Adds new stream subscription_with_scheduled_changes
0.5.52024-07-0640965Update dependencies
0.5.42024-06-2540332Update dependencies
0.5.32024-06-2340074Update dependencies
0.5.22024-06-0639217[autopull] Upgrade base image to v1.2.2
0.5.12024-04-2436633Schema descriptions and CDK 0.80.0
0.5.02024-03-2836518Updates CDK to ^0, updates IncrementalSingleSliceCursor
0.4.22024-03-1436037Adds fields: coupon_constraints to coupon stream, billing_month to customer stream, and error_detail to transaction stream schemas
0.4.12024-03-1335509Updates CDK version to latest (0.67.1), updates site_migration_detail record filtering
0.4.02024-02-1234053Add missing fields to and cleans up schemas, adds incremental support for gift, site_migration_detail, and unbilled_charge streams
0.3.12024-02-1235169Manage dependencies with Poetry
0.3.02023-12-2633696Add new stream, add fields to existing streams
0.2.62023-12-1932100Add new fields in streams
0.2.52023-10-1931599Base image migration: remove Dockerfile and use the python-connector-base image
0.2.42023-08-0128905Updated the connector to use latest CDK version
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
Advanced Analytica

Most businesses are sitting on information they can’t use at speed. The people who hold it are busy, and when they leave, the knowledge goes with them. The documents are static, and the processes around them weren’t designed for AI.

Advanced Analytica works with these businesses to turn that information into structured data assets. Once they're integrated, AI systems can govern it, and the business can use it. We bring in the strategy, the specification and the AI skills to rework how the business operates.

MOVE FAST. STAY SAFE.