> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Chargebee

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (Basic) | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | End-user authorization guide | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ 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 | ✅ |

> [accordion] ✅ 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 |
| - | - | - |
| `cancel-subscription` | Cancel a subscription (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-credit-note` | Create a credit note against an invoice. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-customer` | Create a new customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-item-family` | Create an item family (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-item-price` | Create an item price (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-item` | Create a catalog item (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-subscription` | Create a subscription for a customer (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-customer` | Delete (soft-delete/archive) a customer. Customer must have no active subscriptions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-credit-note` | Retrieve a single credit note by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-customer` | Retrieve a single customer by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-invoice` | Retrieve a single invoice by ID | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-item-family` | Retrieve a single item family by ID (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-item-price` | Retrieve a single item price by ID (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-item` | Retrieve a single catalog item by ID (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-subscription` | Retrieve a single subscription by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-coupon-sets` | List coupon sets (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-coupons` | List coupons (Product Catalog 1.0 accounts only). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-credit-notes` | List credit notes with optional filters | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-customers` | List customers with optional filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-events` | List webhook events with optional filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-invoices` | List invoices with optional filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-item-families` | List item families (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-item-prices` | List item prices (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-items` | List catalog items (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-payment-sources` | List payment sources for a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-subscriptions` | List subscriptions with optional filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-transactions` | List transactions with optional filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-customer` | Update a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-item-price` | Update an item price (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-item` | Update a catalog item (Product Catalog 2.0). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-subscription` | Update an active subscription (Product Catalog 2.0) | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `void-credit-note` | Void a credit note. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `coupon-sets` | Sync coupon sets as a full refresh (Product Catalog 2.0). PC2 replacement for legacy /coupons. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `credit-notes` | Sync credit notes incrementally using updated\_at filter. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `customers` | Sync customers incrementally using updated\_at timestamp filter. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `events` | Sync events incrementally using occurred\_at + event ID cursor. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `invoices` | Sync invoices incrementally using updated\_at timestamp filter. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `item-families` | Sync item families as a full refresh (Product Catalog 2.0). Dataset is small and static. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `item-prices` | Sync item prices incrementally using updated\_at filter (Product Catalog 2.0). | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `items` | Sync catalog items incrementally using updated\_at filter (Product Catalog 2.0). | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `subscriptions` | Sync subscriptions incrementally using updated\_at timestamp filter. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `transactions` | Sync transactions incrementally using updated\_at timestamp filter. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/chargebee.mdx)

## Useful links

Chargebee provides REST APIs and webhook to interact with their data. Only the REST APIs is currently supported.
[API docs](https://apidocs.chargebee.com/docs/api/)

## Connection configuration in Nango

* Chargebee requires a user specific subdomain for the API base URL.

## API gotchas

* Chargebee uses `Basic` auth to access different endpoints. Provide your `API key` as 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 `429` [docs here](https://apidocs.chargebee.com/docs/api/error-handling?prod_cat_ver=2#api_rate_limits).
  * Test sites: \~750 API calls per every 5 minutes
  * Live sites: \~150 API calls per site per minute

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/chargebee.mdx)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.