Chargebee (Source)
Introduction
The Chargebee source connector lets you connect to your Chargebee site using an API key.
Setup
Prerequisites
- A Chargebee account with access to the site you want to connect.
- An API key with permission to read resources (the connector validates credentials by calling the Customers API).
Create an API key in Chargebee
- In Chargebee, create or locate an API key (typically from Settings → Configure Chargebee → API Keys).
- Copy the API key value. You will provide it to the connector as
api_key.
Authentication
Chargebee authentication uses HTTP Basic Auth:
- Username: your Chargebee API key (
api_key) - Password: empty
During connection setup, the connector validates credentials by making a request to:
GET https://{site}.chargebee.com/api/v2/customers?limit=1
Configuration
| Field | Type | Required | Description |
|---|---|---|---|
site | string | ✅ | Your Chargebee site. You can provide either the site subdomain (for example, acme-test) or a full HTTPS URL/host (for example, https://acme-test.chargebee.com or acme-test.chargebee.com). The connector enforces an https URL and a chargebee.com host. |
api_key | string | ✅ | Chargebee API key used as the Basic Auth username. |
site formatting rules
The connector accepts several formats and normalizes them to a Chargebee base URL:
acme-test→https://acme-test.chargebee.comacme-test.chargebee.com→https://acme-test.chargebee.comhttps://acme-test.chargebee.com→ used as-is
Notes:
- The URL must use HTTPS.
- The host must be
chargebee.comor a subdomain ofchargebee.com.
Streams
This connector is currently under development and does not yet extract data streams.
- Catalog discovery currently returns an empty catalog.
- Sync/extraction is not yet available.