Skip to main content

Chargebee

Availability:
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
Airbyte Connector
Connector Version:
0.6.18(Last updated 20 hours ago)
CDK Version:
5.17.0
Sync Success Rate:
Usage Rate:

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

Prerequisites​

To set up the Chargebee source connector, you will need:

info

All Chargebee sites created from May 5, 2021 onward will have Product Catalog 2.0 enabled by default. Sites created prior to this date will use Product Catalog 1.0.

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. Connector defaults to Product Catalog 2.0 unless otherwise specified.
  9. Click Set up source.

Supported sync modes​

The Chargebee source connector supports the following sync modes:

Supported streams​

Most streams are supported regardless of your Chargebee site's 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

When using incremental sync mode, the Attached Items stream behaves differently than the other streams. Whereas other incremental streams read and output only new records, the Attached Items stream reads all records but only outputs new records, making it more demanding on your Chargebee API quota. Each sync incurs API calls equal to the total number of attached items in your Chargebee instance divided by 100, regardless of the actual number of Attached Items changed or synced.

Limitations & Troubleshooting​

Expand to see details about the Chargebee connector limitations and troubleshooting.

Connector limitations​

Rate limiting​

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.

Troubleshooting​

  • Check out common troubleshooting issues for the Instagram source connector on our Airbyte Forum.

Reference​

Config fields reference

Field
Type
Property name
string
site_api_key
string
site
string
start_date
string
product_catalog

Changelog​

Expand to review
VersionDatePull RequestSubject
0.6.182024-10-3147099Update dependencies
0.6.172024-10-2846846Update 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
Was this page helpful?