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

# Chargebee

> Read Chargebee subscriptions, customers, and invoices and create customers for subscription billing

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: Basic auth.
* **Connection**: HTTP Basic auth with `CHARGEBEE_API_KEY` as the username and `CHARGEBEE_API_PASSWORD` as the password.
* **Docs**: [https://apidocs.chargebee.com/docs/api/auth](https://apidocs.chargebee.com/docs/api/auth)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable                 | Required | Description                                                                                                                                                      |
| ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CHARGEBEE_API_KEY`      | Yes      | Chargebee API key, used as the HTTP Basic username (Settings → Configure Chargebee → API Keys and Webhooks) [Docs](https://apidocs.chargebee.com/docs/api/auth). |
| `CHARGEBEE_API_PASSWORD` | No       | HTTP Basic password - Chargebee expects this to stay empty; leave it as an empty string                                                                          |
| `CHARGEBEE_SITE`         | Yes      | Chargebee site name (the subdomain of your Chargebee account, e.g. acme or acme-test) [Docs](https://apidocs.chargebee.com/docs/api).                            |

## Setup

1. **Create a Chargebee account**: Sign up at [https://www.chargebee.com](https://www.chargebee.com). A test site (e.g. acme-test.chargebee.com) is created automatically when you sign up - use it for development before switching to your live site.
2. **Create an API key**: In the Chargebee app go to Settings → Configure Chargebee → API Keys and Webhooks → API Keys, click Add an API Key, choose Full-Access Key, and copy the generated key.
3. **Set environment variables**: Add CHARGEBEE\_API\_KEY (the key from step 2) and CHARGEBEE\_SITE (your site subdomain, e.g. acme-test) to your .env. Leave CHARGEBEE\_API\_PASSWORD unset or empty - Chargebee uses the API key as the HTTP Basic username with an empty password.
4. **Verify access**: Run List Subscriptions with site set to your CHARGEBEE\_SITE value. All requests go to https\://\{site}.chargebee.com/api/v2 over HTTPS.

* API keys are environment-specific: your test site and live site have separate keys and separate site subdomains.
* Chargebee filters use bracket operators in query parameter names, e.g. status\[is]=active or email\[is]=[jane@example.com](mailto:jane@example.com).
* List endpoints paginate with an opaque next\_offset string - pass it back as the offset parameter to fetch the next page.

Provider API reference: [https://apidocs.chargebee.com/docs/api](https://apidocs.chargebee.com/docs/api)

## Tools

| Tool               | Access | Description                                                                                                         |
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------- |
| List Subscriptions | Read   | List subscriptions with optional status or customer filtering                                                       |
| Get Subscription   | Read   | Retrieve a single subscription with its plan, status, and billing details                                           |
| List Customers     | Read   | List customers with optional email filtering                                                                        |
| List Invoices      | Read   | List invoices with optional status, customer, or subscription filtering                                             |
| List Item Prices   | Read   | List item prices (plans, addons, charges) in the catalog to find IDs and pricing for subscriptions                  |
| Get Invoice        | Read   | Retrieve a single invoice with its line items, amounts due, and linked payments                                     |
| List Transactions  | Read   | List payment-level transactions (payments, refunds, authorizations) behind invoices, e.g. to review failed payments |
| Create Customer    | Write  | Create a new customer record in Chargebee                                                                           |

## Example prompts

* List my active Chargebee subscriptions and summarize them by plan.
* Show Chargebee invoices with status payment\_due or not\_paid and which customers they belong to.
* Look up a Chargebee customer by email and show their subscriptions and recent invoices.