Commerce & billing
Set up Chargebee
Connect Chargebee to make subscription billing searchable — customers, subscriptions, invoices, credit notes and the item catalog, with subscriptions, invoices and credit notes linked to their customer, so “what does this customer pay us and since when” and “which invoices are open” answer from the billing system itself. Payment details are never read. Read-only.
Before you start
- A Chargebee API key, created under Settings → Configure Chargebee → API keys with read-only access — that is everything this source touches. A full-access key works too but grants far more than needed.
- The site name — the your-company in your-company.chargebee.com, the permanent address in the browser's address bar when you are signed in, whatever domain the business uses. A test site (ending in -test) works too.
- Can never write: only reads are ever issued, and payment instrument fields — card and payment-method details, masked or not — are never requested or stored.
- In Chargebee open Settings → Configure Chargebee → API keys and create a key with read-only access.
- Documents → Chargebee, enter Site (just the site name — a pasted full address is trimmed) and paste the key as API key.
- Choose access groups, Test, then Sync.
What comes in
- Customers — name (the company or email when Chargebee has no person's name), email, company and customer since.
- Subscriptions — the item price or plan, status, amount, currency, when it started and when it next bills.
- Invoices — number, status, amount due, amount paid, currency and date, with up to 10 line items.
- Credit notes — number, status, total, currency, reason code and date, as records of their own, so a credited or refunded invoice shows its credit note instead of folding it silently into the invoice.
- Item catalog — each item's name, type, status and description, deleted items skipped; a site without Product Catalog 2.0 reads its plans instead.
- Subscriptions, invoices and credit notes link to their customer, and a customer's record sums up what hangs off it — how many of each, their totals and the latest date. Amounts are rendered in whole currency from Chargebee's minor units; zero-decimal currencies such as JPY are already whole.
Access
Access is allow-only: the groups chosen on the source cover everything Chargebee brings in — the source exposes no per-item viewers to mirror.
Each object type and the catalog cap at 3,000, most-recently-updated first; when a cap is reached the sync summary says so, and anything that ages past it stays searchable rather than disappearing. Test reaches your-company.chargebee.com and counts customers; a rejected key reads as Chargebee rejecting the credentials. Revoke access any time by deleting the key under Settings → Configure Chargebee → API keys.
Last updated 20 Sep 2026