Chargebee
Overview
Pre-built tooling
✅ Authorization
| Tools | Status |
|---|---|
| Pre-built authorization (Basic) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | ✅ |
| Expired credentials detection | ✅ |
✅ Read & write data
| Tools | Status |
|---|---|
| Pre-built integrations | ✅ |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Tenklo on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) |
| Proxy requests | ✅ |
✅ Observability & data quality
| Tools | Status |
|---|---|
| HTTP request logging | ✅ |
| End-to-end type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
✅ Customization
| Tools | Status |
|---|---|
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: <48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) |
| Per-customer configurations | ✅ |
Others
| Function name | Description | Type | Source code |
|---|---|---|---|
cancel-subscription | Cancel a subscription (Product Catalog 2.0). | Action | 🔗 Github |
create-credit-note | Create a credit note against an invoice. | Action | 🔗 Github |
create-customer | Create a new customer. | Action | 🔗 Github |
create-item-family | Create an item family (Product Catalog 2.0). | Action | 🔗 Github |
create-item-price | Create an item price (Product Catalog 2.0). | Action | 🔗 Github |
create-item | Create a catalog item (Product Catalog 2.0). | Action | 🔗 Github |
create-subscription | Create a subscription for a customer (Product Catalog 2.0). | Action | 🔗 Github |
delete-customer | Delete (soft-delete/archive) a customer. Customer must have no active subscriptions. | Action | 🔗 Github |
get-credit-note | Retrieve a single credit note by ID. | Action | 🔗 Github |
get-customer | Retrieve a single customer by ID. | Action | 🔗 Github |
get-invoice | Retrieve a single invoice by ID | Action | 🔗 Github |
get-item-family | Retrieve a single item family by ID (Product Catalog 2.0). | Action | 🔗 Github |
get-item-price | Retrieve a single item price by ID (Product Catalog 2.0). | Action | 🔗 Github |
get-item | Retrieve a single catalog item by ID (Product Catalog 2.0). | Action | 🔗 Github |
get-subscription | Retrieve a single subscription by ID. | Action | 🔗 Github |
list-coupon-sets | List coupon sets (Product Catalog 2.0). | Action | 🔗 Github |
list-coupons | List coupons (Product Catalog 1.0 accounts only). | Action | 🔗 Github |
list-credit-notes | List credit notes with optional filters | Action | 🔗 Github |
list-customers | List customers with optional filters. | Action | 🔗 Github |
list-events | List webhook events with optional filters. | Action | 🔗 Github |
list-invoices | List invoices with optional filters. | Action | 🔗 Github |
list-item-families | List item families (Product Catalog 2.0). | Action | 🔗 Github |
list-item-prices | List item prices (Product Catalog 2.0). | Action | 🔗 Github |
list-items | List catalog items (Product Catalog 2.0). | Action | 🔗 Github |
list-payment-sources | List payment sources for a customer. | Action | 🔗 Github |
list-subscriptions | List subscriptions with optional filters. | Action | 🔗 Github |
list-transactions | List transactions with optional filters. | Action | 🔗 Github |
update-customer | Update a customer. | Action | 🔗 Github |
update-item-price | Update an item price (Product Catalog 2.0). | Action | 🔗 Github |
update-item | Update a catalog item (Product Catalog 2.0). | Action | 🔗 Github |
update-subscription | Update an active subscription (Product Catalog 2.0) | Action | 🔗 Github |
void-credit-note | Void a credit note. | Action | 🔗 Github |
coupon-sets | Sync coupon sets as a full refresh (Product Catalog 2.0). PC2 replacement for legacy /coupons. | Sync | 🔗 Github |
credit-notes | Sync credit notes incrementally using updated_at filter. | Sync | 🔗 Github |
customers | Sync customers incrementally using updated_at timestamp filter. | Sync | 🔗 Github |
events | Sync events incrementally using occurred_at + event ID cursor. | Sync | 🔗 Github |
invoices | Sync invoices incrementally using updated_at timestamp filter. | Sync | 🔗 Github |
item-families | Sync item families as a full refresh (Product Catalog 2.0). Dataset is small and static. | Sync | 🔗 Github |
item-prices | Sync item prices incrementally using updated_at filter (Product Catalog 2.0). | Sync | 🔗 Github |
items | Sync catalog items incrementally using updated_at filter (Product Catalog 2.0). | Sync | 🔗 Github |
subscriptions | Sync subscriptions incrementally using updated_at timestamp filter. | Sync | 🔗 Github |
transactions | Sync transactions incrementally using updated_at timestamp filter. | Sync | 🔗 Github |
Access requirements
| Pre-Requisites | Status | Comment |
|---|---|---|
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ |
Setup guide
No setup guide yet.
Need help getting started? Get help in the community.
Contribute improvements to the setup guide by editing this page
Useful links
Chargebee provides REST APIs and webhook to interact with their data. Only the REST APIs is currently supported. API docs
Connection configuration in Tenklo
- Chargebee requires a user specific subdomain for the API base URL.
API gotchas
- Chargebee uses
Basicauth to access different endpoints. Provide yourAPI keyas the Username value and leave the password field empty. - Rate limiting: APIs are rate limited in both test and live sites. Upon breaching the rate limit APIs respond with
429docs here.- Test sites: ~750 API calls per every 5 minutes
- Live sites: ~150 API calls per site per minute
Contribute API gotchas by editing this page