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

# Chargebee

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://{{.workspace}}.chargebee.com/api`.

### Supported objects

The Chargebee connector supports reading from the following objects:

* [attached\_items](https://apidocs.chargebee.com/docs/api/attached_items)
* [business\_entities/transfers](https://apidocs.chargebee.com/docs/api/business_entities)
* [comments](https://apidocs.chargebee.com/docs/api/comments)
* [coupon\_codes](https://apidocs.chargebee.com/docs/api/coupon_codes)
* [coupon\_sets](https://apidocs.chargebee.com/docs/api/coupon_sets)
* [coupons](https://apidocs.chargebee.com/docs/api/coupons)
* [credit\_notes](https://apidocs.chargebee.com/docs/api/credit_notes)
* [currencies](https://apidocs.chargebee.com/docs/api/currencies)
* [customers](https://apidocs.chargebee.com/docs/api/customers)
* [entitlements](https://apidocs.chargebee.com/docs/api/entitlements)
* [events](https://apidocs.chargebee.com/docs/api/events)
* [features](https://apidocs.chargebee.com/docs/api/features)
* [gifts](https://apidocs.chargebee.com/docs/api/gifts)
* [hosted\_pages](https://apidocs.chargebee.com/docs/api/hosted_pages)
* [invoices](https://apidocs.chargebee.com/docs/api/invoices)
* [item\_families](https://apidocs.chargebee.com/docs/api/item_families)
* [item\_prices](https://apidocs.chargebee.com/docs/api/item_prices)
* [items](https://apidocs.chargebee.com/docs/api/items)
* [omnichannel\_one\_time\_orders](https://apidocs.chargebee.com/docs/api/omnichannel_transactions)
* [omnichannel\_subscriptions](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions)
* [orders](https://apidocs.chargebee.com/docs/api/orders)
* [payment\_sources](https://apidocs.chargebee.com/docs/api/payment_sources)
* [plans](https://apidocs.chargebee.com/docs/api/plans)
* [promotional\_credits](https://apidocs.chargebee.com/docs/api/promotional_credits)
* [quotes](https://apidocs.chargebee.com/docs/api/quotes)
* [subscriptions](https://apidocs.chargebee.com/docs/api/subscriptions)
* [transactions](https://apidocs.chargebee.com/docs/api/transactions)
* [unbilled\_charges](https://apidocs.chargebee.com/docs/api/unbilled_charges)
* [usages](https://apidocs.chargebee.com/docs/api/usages)
* [virtual\_bank\_accounts](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts)
* [webhook\_endpoints](https://apidocs.chargebee.com/docs/api/webhook_endpoints)

### Objects supporting incremental read:

* `coupons`
* `credit_notes`
* `customers`
* `hosted_pages`
* `invoices`
* `item_prices`
* `items`
* `orders`
* `payment_sources`
* `quotes`
* `subscriptions`
* `transactions`
* `usages`
* `virtual_bank_accounts`

For all other objects, a full read of the Chargebee instance will be done per scheduled read.

The Chargebee connector supports writing to the following objects:

* [comments](https://apidocs.chargebee.com/docs/api/comments)
* [coupons](https://apidocs.chargebee.com/docs/api/coupons)
* [coupon\_sets](https://apidocs.chargebee.com/docs/api/coupon_sets)
* [credit\_notes](https://apidocs.chargebee.com/docs/api/credit_notes)
* [currencies](https://apidocs.chargebee.com/docs/api/currencies)
* [customers](https://apidocs.chargebee.com/docs/api/customers)
* [estimates](https://apidocs.chargebee.com/docs/api/estimates)
* [features](https://apidocs.chargebee.com/docs/api/features)
* [invoices](https://apidocs.chargebee.com/docs/api/invoices)
* [item\_families](https://apidocs.chargebee.com/docs/api/item_families)
* [item\_prices](https://apidocs.chargebee.com/docs/api/item_prices)
* [items](https://apidocs.chargebee.com/docs/api/items)
* [offer\_events](https://apidocs.chargebee.com/docs/api/offer_events)
* [offer\_fulfillments](https://apidocs.chargebee.com/docs/api/offer_fulfillments)
* [orders](https://apidocs.chargebee.com/docs/api/orders)
* [payment\_intents](https://apidocs.chargebee.com/docs/api/payment_intents)
* [payment\_schedule\_schemes](https://apidocs.chargebee.com/docs/api/payment_schedule_schemes)
* [payment\_vouchers](https://apidocs.chargebee.com/docs/api/payment_vouchers)
* [portal\_sessions](https://apidocs.chargebee.com/docs/api/portal_sessions)
* [promotional\_credits](https://apidocs.chargebee.com/docs/api/promotional_credits)
* [quotes](https://apidocs.chargebee.com/docs/api/quotes)
* [recorded\_purchases](https://apidocs.chargebee.com/docs/api/recorded_purchases)
* [transactions](https://apidocs.chargebee.com/docs/api/transactions)
* [unbilled\_charges](https://apidocs.chargebee.com/docs/api/unbilled_charges)
* [virtual\_bank\_accounts](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts)
* [webhook\_endpoints](https://apidocs.chargebee.com/docs/api/webhook_endpoints)

### Example integration

For an example manifest file of a Chargebee integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/chargebee/amp.yaml).

## Using the connector

This connector uses Basic auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with Chargebee:

* Create a manifest file like the example above.
* Deploy it using the [amp CLI](/cli/overview).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their username, password and site name.
* Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the correct header required by Basic Auth. Please note that this connector's base URL is `https://{{.site}}.chargebee.com/api`.

## Creating Basic Auth Credentials for Chargebee

Chargebee uses the API Key as the username when authenticating with Basic Auth. The password field should be left blank.

[Click here](https://www.chargebee.com/docs/billing/2.0/site-configuration/api_keys) for more information about generating an API key for Chargebee. The UI components will display this link, so that your users can successfully create API keys.