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

# Chargebee

## Overview

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                           | Status |
    | ------------------------------- | ------ |
    | Pre-built authorization (Basic) | ✅      |
    | Pre-built authorization UI      | ✅      |
    | Custom authorization UI         | ✅      |
    | End-user authorization guide    | ✅      |
    | Expired credentials detection   | ✅      |
  </Accordion>

  <Accordion title="✅ 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>

  <Accordion title="✅ 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>

  <Accordion title="✅ 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        | ✅                              |
  </Accordion>
</AccordionGroup>

### Others

| Function name          | Description                                                                                    | Type                                           | Source code                                                                                                                    |
| ---------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `cancel-subscription`  | Cancel a subscription (Product Catalog 2.0).                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/cancel-subscription.ts)  |
| `create-credit-note`   | Create a credit note against an invoice.                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/create-credit-note.ts)   |
| `create-customer`      | Create a new customer.                                                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/create-customer.ts)      |
| `create-item-family`   | Create an item family (Product Catalog 2.0).                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/create-item-family.ts)   |
| `create-item-price`    | Create an item price (Product Catalog 2.0).                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/create-item-price.ts)    |
| `create-item`          | Create a catalog item (Product Catalog 2.0).                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/create-item.ts)          |
| `create-subscription`  | Create a subscription for a customer (Product Catalog 2.0).                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/create-subscription.ts)  |
| `delete-customer`      | Delete (soft-delete/archive) a customer. Customer must have no active subscriptions.           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/delete-customer.ts)      |
| `get-credit-note`      | Retrieve a single credit note by ID.                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/get-credit-note.ts)      |
| `get-customer`         | Retrieve a single customer by ID.                                                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/get-customer.ts)         |
| `get-invoice`          | Retrieve a single invoice by ID                                                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/get-invoice.ts)          |
| `get-item-family`      | Retrieve a single item family by ID (Product Catalog 2.0).                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/get-item-family.ts)      |
| `get-item-price`       | Retrieve a single item price by ID (Product Catalog 2.0).                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/get-item-price.ts)       |
| `get-item`             | Retrieve a single catalog item by ID (Product Catalog 2.0).                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/get-item.ts)             |
| `get-subscription`     | Retrieve a single subscription by ID.                                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/get-subscription.ts)     |
| `list-coupon-sets`     | List coupon sets (Product Catalog 2.0).                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-coupon-sets.ts)     |
| `list-coupons`         | List coupons (Product Catalog 1.0 accounts only).                                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-coupons.ts)         |
| `list-credit-notes`    | List credit notes with optional filters                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-credit-notes.ts)    |
| `list-customers`       | List customers with optional filters.                                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-customers.ts)       |
| `list-events`          | List webhook events with optional filters.                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-events.ts)          |
| `list-invoices`        | List invoices with optional filters.                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-invoices.ts)        |
| `list-item-families`   | List item families (Product Catalog 2.0).                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-item-families.ts)   |
| `list-item-prices`     | List item prices (Product Catalog 2.0).                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-item-prices.ts)     |
| `list-items`           | List catalog items (Product Catalog 2.0).                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-items.ts)           |
| `list-payment-sources` | List payment sources for a customer.                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-payment-sources.ts) |
| `list-subscriptions`   | List subscriptions with optional filters.                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-subscriptions.ts)   |
| `list-transactions`    | List transactions with optional filters.                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/list-transactions.ts)    |
| `update-customer`      | Update a customer.                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/update-customer.ts)      |
| `update-item-price`    | Update an item price (Product Catalog 2.0).                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/update-item-price.ts)    |
| `update-item`          | Update a catalog item (Product Catalog 2.0).                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/update-item.ts)          |
| `update-subscription`  | Update an active subscription (Product Catalog 2.0)                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/update-subscription.ts)  |
| `void-credit-note`     | Void a credit note.                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/actions/void-credit-note.ts)     |
| `coupon-sets`          | Sync coupon sets as a full refresh (Product Catalog 2.0). PC2 replacement for legacy /coupons. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/coupon-sets.ts)            |
| `credit-notes`         | Sync credit notes incrementally using updated\_at filter.                                      | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/credit-notes.ts)           |
| `customers`            | Sync customers incrementally using updated\_at timestamp filter.                               | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/customers.ts)              |
| `events`               | Sync events incrementally using occurred\_at + event ID cursor.                                | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/events.ts)                 |
| `invoices`             | Sync invoices incrementally using updated\_at timestamp filter.                                | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/invoices.ts)               |
| `item-families`        | Sync item families as a full refresh (Product Catalog 2.0). Dataset is small and static.       | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/item-families.ts)          |
| `item-prices`          | Sync item prices incrementally using updated\_at filter (Product Catalog 2.0).                 | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/item-prices.ts)            |
| `items`                | Sync catalog items incrementally using updated\_at filter (Product Catalog 2.0).               | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/items.ts)                  |
| `subscriptions`        | Sync subscriptions incrementally using updated\_at timestamp filter.                           | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/subscriptions.ts)          |
| `transactions`         | Sync transactions incrementally using updated\_at timestamp filter.                            | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/chargebee/syncs/transactions.ts)           |

## 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).</Tip>

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

## 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)</Note>