> For the complete documentation index, see [llms.txt](https://docs.coupler.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coupler.io/sources/category/ecommerce/chargebee.md).

# Chargebee

Chargebee is a subscription billing and revenue management platform used by SaaS, ecommerce, and recurring-revenue businesses. It handles everything from subscriptions and invoices to coupons and customer data in one place.

Connecting Chargebee to Coupler.io lets you pull your billing and subscription data into any destination — spreadsheets, BI tools, or AI assistants — without writing a single line of code.

**Why connect Chargebee to Coupler.io?**

* Centralize subscription, invoice, and transaction data in Google Sheets, BigQuery, Looker Studio, or AI tools like ChatGPT, Claude, or Gemini
* Combine multiple Chargebee entities (e.g., join Subscriptions with Customers) using Coupler.io's Join transformation
* Append data from multiple Chargebee sites into a single dataset
* Keep your reports up to date with scheduled data refreshes

## Prerequisites

Before you start, make sure you have:

* A Chargebee account (any plan)
* A Chargebee API key — you can find this in your Chargebee dashboard under **Settings > Configure Chargebee > API Keys**
* Your Chargebee site name (the subdomain in your Chargebee URL, e.g., `yoursite` from `yoursite.chargebee.com`)

## Quick start

{% hint style="success" %}
Start with the **Subscriptions** or **Invoices** entity — these give you the most actionable billing data right away.
{% endhint %}

{% stepper %}
{% step %}
**Create a new data flow in Coupler.io.** Go to your Coupler.io dashboard and click **Add data flow**. Search for and select **Chargebee** as your source.
{% endstep %}

{% step %}
**Enter your Chargebee credentials.** Paste your API key and enter your Chargebee site name. Coupler.io will use these to authenticate with your account.
{% endstep %}

{% step %}
**Select an entity.** Choose which Chargebee entity you want to export — for example, Subscriptions, Invoices, or Customers. You can add more sources to the same data flow later.
{% endstep %}

{% step %}
**Set a start date.** Use the date picker to define how far back Coupler.io should pull data. Records created before this date will not be included.
{% endstep %}

{% step %}
**Choose a destination.** Select where you want your data to land — Google Sheets, Excel, BigQuery, Looker Studio, or an AI destination like ChatGPT, Claude, or Gemini.
{% endstep %}

{% step %}
**Run the data flow.** Click **Run** to perform a manual sync. Once it completes successfully, your Chargebee data will appear in your chosen destination.
{% endstep %}
{% endstepper %}

## Available entities

| Entity                              | What it contains                           |
| ----------------------------------- | ------------------------------------------ |
| Subscriptions                       | Active and historical subscription records |
| Subscription with scheduled changes | Subscriptions with pending future changes  |
| Customers                           | Customer profiles and metadata             |
| Invoices                            | Invoice details, amounts, and statuses     |
| Transactions                        | Payment transactions and outcomes          |
| Credit notes                        | Issued credit notes against invoices       |
| Unbilled charges                    | Charges not yet added to an invoice        |
| Orders                              | Physical/digital order records             |
| Items                               | Product catalog items                      |
| Item prices                         | Pricing details per item                   |
| Item families                       | Groupings of related items                 |
| Attached items                      | Items linked to plans or subscriptions     |
| Plans                               | Subscription plan definitions              |
| Addons                              | Add-on product definitions                 |
| Coupons                             | Discount coupon records                    |
| Promotional credits                 | Promotional credit balances                |
| Payment sources                     | Saved payment methods                      |
| Contacts                            | Billing/account contacts                   |
| Events                              | Audit log of Chargebee events              |
| Hosted pages                        | Checkout and portal page records           |
| Quotes                              | Sales quotes                               |
| Quote line groups                   | Line item groups within quotes             |
| Gifts                               | Gift subscription records                  |
| Virtual bank accounts               | Virtual bank account details               |
| Differential prices                 | Price overrides for specific customers     |
| Comments                            | Internal comments on records               |
| Site migration details              | Data from site migrations                  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.coupler.io/sources/category/ecommerce/chargebee.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.