Chargebee Native
This connector captures data from Chargebee into Flow collections in real-time. It is a native implementation that provides enhanced performance and reliability compared to the third-party connector.
It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-chargebee-native:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.
Supported data resources
The connector supports many Chargebee resources, which vary based on your Product Catalog version. Below is a comprehensive list of available resources and their capabilities:
| Stream | Product Catalog 1.0 | Product Catalog 2.0 | Incremental | Full Refresh | Notes |
|---|---|---|---|---|---|
| Addons | ✓ | - | ✓ | - | - |
| Attached Items | - | ✓ | ✓ | - | Associated with Items |
| Comments | ✓ | ✓ | ✓ | - | - |
| Contacts | ✓ | ✓ | - | ✓ | Associated with Customers |
| Coupons | ✓ | ✓ | ✓ | - | - |
| Credit Notes | ✓ | ✓ | ✓ | - | - |
| Customers | ✓ | ✓ | ✓ | - | - |
| Differential Prices | - | ✓ | - | ✓ | - |
| Events | ✓ | ✓ | ✓ | - | - |
| Gifts | ✓ | ✓ | - | ✓ | - |
| Hosted Pages | ✓ | ✓ | ✓ | - | - |
| Invoices | ✓ | ✓ | ✓ | - | - |
| Item Families | - | ✓ | ✓ | - | - |
| Item Prices | - | ✓ | ✓ | - | - |
| Items | - | ✓ | ✓ | - | - |
| Orders | ✓ | ✓ | ✓ | - | - |
| Payment Sources | ✓ | ✓ | ✓ | - | - |
| Plans | ✓ | - | ✓ | - | - |
| Promotional Credits | ✓ | ✓ | ✓ | - | - |
| Quote Line Groups | ✓ | ✓ | - | ✓ | Requires Performance/Enterprise plan |
| Quotes | ✓ | ✓ | ✓ | - | Requires Performance/Enterprise plan |
| Site Migration Details | ✓ | ✓ | - | ✓ | - |
| Subscriptions | ✓ | ✓ | ✓ | - | - |
| Subscriptions with Scheduled Changes | ✓ | ✓ | - | ✓ | Associated with Subscriptions |
| Transactions | ✓ | ✓ | ✓ | - | - |
| Unbilled Charges | ✓ | ✓ | - | ✓ | - |
| Virtual Bank Accounts | ✓ | ✓ | ✓ | - | - |
Prerequisites
To set up the Chargebee Native source connector, you'll need:
- A Chargebee API key
- Your Chargebee site name
- Your Product Catalog version (1.0 or 2.0)
Configuration
You can configure the connector either in the Flow web app or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Chargebee Native source connector.
Properties
Endpoint
| Property | Title | Description | Type | Required/Default |
|---|---|---|---|---|
/credentials/api_key | API Key | Chargebee API Key for authentication. | string | Required |
/credentials/credentials_title | Credentials Title | Name of the credentials set. | string | Required, "API Key" |
/site | Site | The site prefix for your Chargebee instance (e.g., 'mycompany' for 'mycompany.chargebee.com'). | string | Required |
/start_date | Start Date | UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated. | string | Required, 30 day ago |
/product_catalog | Product Catalog | Product Catalog version of your Chargebee site (1.0 or 2.0). | string | Required, 1.0 |
Bindings
| Property | Title | Description | Type | Required/Default |
|---|---|---|---|---|
/name | Resource Name | Name of the Chargebee resource to capture. | string | Required |
/interval | Sync Interval | Interval between data syncs (e.g., PT2M for every 2 minutes). | string |
Sample
captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-chargebee-native:dev
config:
credentials:
credentials_title: API Key
api_key: <secret>
site: mycompany
start_date: "2024-01-01T00:00:00Z"
product_catalog: "2.0"
bindings:
- resource:
name: customers
target: ${PREFIX}/customers
- resource:
name: subscriptions
target: ${PREFIX}/subscriptions
Resource Notes
- Some resources (Quotes and Quote Line Groups) require a Performance or Enterprise Chargebee subscription plan.