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

# Chargebee

> Connect Chargebee to your Atako agents — 20 read and 13 write actions.

Let your agents run your Chargebee billing — manage customers, plans and prices, create or cancel subscriptions, and track invoices and credit notes.

## Connection

* **Authentication**: API key.
* **Required settings**:
  * **Site name** — yourcompany in yourcompany.chargebee.com

<Note>
  Chargebee admin console → Settings → Configure Chargebee → API Keys and Webhooks → API Keys tab → + Add API Key. Pick "Read-Only Key" if the agent only needs read access, otherwise "Full-Access Key", then copy the key (starts with live\_ or test\_). Use a key from your test site to try things out safely.

  See [Chargebee's documentation](https://www.chargebee.com/docs/2.0/api_keys.html).
</Note>

## Read actions (20)

| Action                 | Description                                                                              |
| ---------------------- | ---------------------------------------------------------------------------------------- |
| `get_credit_note`      | Fetch a credit note by id, including amounts allocated, refunded and available.          |
| `get_customer`         | Fetch a customer by id, including billing info and unbilled/promotional credits.         |
| `get_invoice`          | Fetch an invoice by id, including line items, status and amounts due/paid.               |
| `get_invoice_pdf`      | Fetch a short-lived download URL for the PDF of an invoice.                              |
| `get_item`             | Fetch an item by id, including its type, family and status.                              |
| `get_item_family`      | Fetch an item family by id.                                                              |
| `get_item_price`       | Fetch an item price by id, including amount, currency and billing period.                |
| `get_subscription`     | Fetch a subscription by id, including status, items and current term.                    |
| `list_coupon_sets`     | List coupon sets (batches of single-use coupon codes), optionally by coupon.             |
| `list_coupons`         | List coupons, optionally filtered by status or discount type.                            |
| `list_credit_notes`    | List credit notes, optionally filtered by customer, invoice, type or status.             |
| `list_customers`       | List customers, optionally filtered by exact email, first or last name.                  |
| `list_events`          | List recent site events (e.g. subscription\_created), optionally by type or time window. |
| `list_invoices`        | List invoices, optionally filtered by customer, subscription or status.                  |
| `list_item_families`   | List the item families of the product catalog.                                           |
| `list_item_prices`     | List item prices, optionally filtered by item, currency or status.                       |
| `list_items`           | List catalog items, optionally filtered by family, type or status.                       |
| `list_payment_sources` | List stored payment sources, optionally filtered by customer, type or status.            |
| `list_subscriptions`   | List subscriptions, optionally filtered by customer, item price or status.               |
| `list_transactions`    | List payment transactions, optionally filtered by customer, type or status.              |

## Write actions (13)

| Action                | Description                                                                          |
| --------------------- | ------------------------------------------------------------------------------------ |
| `cancel_subscription` | Cancel a subscription now, at end of term, or at a specific date.                    |
| `create_credit_note`  | Issue a credit note (adjustment or refundable) against an existing invoice.          |
| `create_customer`     | Create a customer to attach subscriptions, invoices and payment sources to.          |
| `create_item`         | Create an item (plan, addon or charge) inside an item family.                        |
| `create_item_family`  | Create an item family — the product grouping plans, addons and charges belong to.    |
| `create_item_price`   | Create an item price — a billable price point (currency, period, model) for an item. |
| `create_subscription` | Create a subscription for an existing customer from one or more item prices.         |
| `delete_customer`     | Permanently delete a customer and all their subscriptions and invoices.              |
| `pause_subscription`  | Pause an active subscription immediately, at end of term, or at a specific date.     |
| `resume_subscription` | Resume a paused subscription immediately or at a specific date.                      |
| `update_customer`     | Update a customer’s name, email, phone, locale or collection settings.               |
| `update_subscription` | Change a subscription’s item prices, quantities, term or coupons.                    |
| `void_invoice`        | Void an unpaid invoice so it is no longer collectible.                               |

## Permissions

Every action above must be explicitly granted to an agent before it can be used. See [Permissions](/integrations/permissions) for the grant model and [Security](/integrations/security) for how credentials are protected.