Chargebee
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:
- Chargebee API key
- Product Catalog version of the Chargebee site you are syncing.
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
- Log into your Airbyte Cloud account or navigate to the Airbyte Open Source dashboard.
- Click Sources and then click + New source.
- On the Set up the source page, select Chargebee from the Source type dropdown.
- Enter the name for the Chargebee connector.
- For Site, enter the site prefix for your Chargebee instance.
- For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
- For API Key, enter the Chargebee API key.
- For Product Catalog, enter the Chargebee Product Catalog version. Connector defaults to Product Catalog 2.0 unless otherwise specified.
- 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.
| Stream | Product Catalog 1.0 | Product 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
integer
num_workers
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.7.2 | 2024-11-20 | 48510 | Ensure no pagination issues on concurrent syncs |
| 0.7.1 | 2024-11-04 | 48133 | Fix error message pattern to handle Product 1.0 related errors |
| 0.7.0 | 2024-10-30 | 47978 | Upgrade the CDK and startup files to sync incremental streams concurrently |
| 0.6.18 | 2024-10-31 | 47099 | Update dependencies |
| 0.6.17 | 2024-10-28 | 46846 | Update CDK dependencies to yield parent records more frequently |
| 0.6.16 | 2024-10-12 | 46846 | Update dependencies |
| 0.6.15 | 2024-10-05 | 46478 | Update dependencies |
| 0.6.14 | 2024-10-03 | 46343 | Added incremental dependency for substreams with Incremental parent streams |
| 0.6.13 | 2024-10-01 | 46294 | Update CDK version to ^5, increased the maxSecondsBetweenMessages to 6 hours |
| 0.6.12 | 2024-09-28 | 46169 | Update dependencies |
| 0.6.11 | 2024-09-21 | 45805 | Update dependencies |
| 0.6.10 | 2024-09-14 | 45254 | Update dependencies |
| 0.6.9 | 2024-08-31 | 45028 | Update dependencies |
| 0.6.8 | 2024-08-24 | 44662 | Update dependencies |
| 0.6.7 | 2024-08-17 | 44265 | Update dependencies |
| 0.6.6 | 2024-08-10 | 43640 | Update dependencies |
| 0.6.5 | 2024-08-03 | 43081 | Update dependencies |
| 0.6.4 | 2024-07-27 | 42626 | Update dependencies |
| 0.6.3 | 2024-07-20 | 42296 | Update dependencies |
| 0.6.2 | 2024-07-13 | 41691 | Update dependencies |
| 0.6.1 | 2024-07-10 | 41113 | Update dependencies |
| 0.6.0 | 2024-07-10 | 39217 | Adds new stream subscription_with_scheduled_changes |
| 0.5.5 | 2024-07-06 | 40965 | Update dependencies |
| 0.5.4 | 2024-06-25 | 40332 | Update dependencies |
| 0.5.3 | 2024-06-23 | 40074 | Update dependencies |
| 0.5.2 | 2024-06-06 | 39217 | [autopull] Upgrade base image to v1.2.2 |
| 0.5.1 | 2024-04-24 | 36633 | Schema descriptions and CDK 0.80.0 |
| 0.5.0 | 2024-03-28 | 36518 | Updates CDK to ^0, updates IncrementalSingleSliceCursor |
| 0.4.2 | 2024-03-14 | 36037 | Adds fields: coupon_constraints to coupon stream, billing_month to customer stream, and error_detail to transaction stream schemas |
| 0.4.1 | 2024-03-13 | 35509 | Updates CDK version to latest (0.67.1), updates site_migration_detail record filtering |
| 0.4.0 | 2024-02-12 | 34053 | Add missing fields to and cleans up schemas, adds incremental support for gift, site_migration_detail, and unbilled_charge streams |
| 0.3.1 | 2024-02-12 | 35169 | Manage dependencies with Poetry |
| 0.3.0 | 2023-12-26 | 33696 | Add new stream, add fields to existing streams |
| 0.2.6 | 2023-12-19 | 32100 | Add new fields in streams |
| 0.2.5 | 2023-10-19 | 31599 | Base image migration: remove Dockerfile and use the python-connector-base image |
| 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 |