Chargebee Connector
Prerequisites
- A Chargebee account (any plan)
- Admin access to generate API keys
Getting Your Credentials
Chargebee uses an API Key and Site Name for authentication.
Step 1: Find Your Site Name
Your site name is the subdomain in your Chargebee URL. For example, if you access Chargebee at https://acme.chargebee.com, your site name is acme.
Step 2: Create an API Key
- Log into your Chargebee admin console
- Go to Settings > Configure Chargebee > API Keys
- Click Create a key
- Select Read-Only access (recommended) or Full Access
- Name it (e.g.,
Landed sync) - Copy the API key
Tip: Use a Read-Only key for security. Landed only reads data from Chargebee.
Configuration in Landed
| Field | Value |
|---|---|
| API Key | Your Chargebee API key (e.g., live_...) |
| Site Name | Your Chargebee subdomain (e.g., acme) |
Available Streams
Chargebee has two Product Catalog versions. The connector auto-detects which version your site uses.
| Stream | Description | Sync Mode | Catalog |
|---|---|---|---|
subscriptions | Active and past subscriptions | Incremental | Both |
customers | Customer records | Incremental | Both |
invoices | Invoice records | Incremental | Both |
transactions | Payment transactions | Incremental | Both |
credit_notes | Credit note records | Incremental | Both |
payment_sources | Stored payment methods | Incremental | Both |
coupons | Discount coupons | Full refresh | Both |
orders | Order records | Incremental | Both |
items | Product items | Incremental | PC2 only |
item_prices | Item price definitions | Incremental | PC2 only |
item_families | Item family groupings | Incremental | PC2 only |
plans | Subscription plans (legacy) | Incremental | PC1 only |
addons | Plan add-ons (legacy) | Incremental | PC1 only |
Note: PC2 streams (items, item_prices, item_families) are only available if your Chargebee site uses Product Catalog 2.0. PC1 streams (plans, addons) are only available on legacy Product Catalog 1.0 sites.
Common Issues
| Symptom | Cause | Fix |
|---|---|---|
401 Unauthorized | Invalid API key or site name | Verify both the API key and site name are correct |
404 Not Found | Wrong site name | Check that the site name matches your Chargebee subdomain exactly |
items stream returns 404 | Site uses PC1 (legacy catalog) | Use plans and addons streams instead |
plans stream returns 404 | Site uses PC2 | Use items, item_prices, and item_families instead |
Rate limit exceeded | Too many API calls | Landed handles rate limiting automatically |
Static IPs for Allowlisting
If your Chargebee configuration requires IP allowlisting:
- Production:
34.170.185.84,35.192.90.94 - Staging:
34.171.93.34