Skip to main content

Chargebee

Overview

The Chargebee source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

This Chargebee source uses the Chargebee Python Client Library.

Output schema

This connector outputs the following streams:

Notes

Some streams may depend on Product Catalog version and be accessible only on sites with specific Product Catalog version. This means that we have following streams:

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

Also, 12 streams from the above 13 incremental streams are pure incremental meaning that they:

  • read only new records;
  • output only new records.

Attached Items incremental stream is also incremental but with one difference, it:

  • read all records;
  • output only new records.

This means that 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.

Features

FeatureSupported?
Full Refresh SyncYes
Incremental - Append SyncYes
Replicate Incremental DeletesNo
SSL connectionYes
NamespacesNo

Performance considerations

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

Getting started

Requirements

  • Chargebee Account;
  • site_api_key - Chargebee API Key wih the necessary permissions (described below);
  • site - Chargebee site prefix for your instance;
  • start_date - start date for incremental streams;
  • product_catalog - Product Catalog version of your Chargebee site (described below).

Setup guide

Log into Chargebee and then generate an API Key. Then follow these instructions, under API Version section, on how to find your Product Catalog version.

Changelog

VersionDatePull RequestSubject
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