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

# Chargebee

> Add ZBX crypto paylinks to Chargebee invoices and subscriptions.

Connect [Chargebee](https://www.chargebee.com/) so invoices can include a ZBX cryptocurrency pay link.

## Auto charge

ZBX does **not** auto-charge crypto. Use wallet / pay link flows for collection. For automatic crypto charging, create an appropriate pay link in the [dashboard](https://merchants.zbx.boomfi.xyz/) and complete the customer wallet consent path where required.

## Enable the integration

### Chargebee API key

1. In Chargebee: **Settings → Configure Chargebee → API keys → Add API key**.
2. Choose a **full-access** key covering the resources you need.
3. Name it (for example “ZBX integration”) and create the key. Store it securely.

### Connect in ZBX

1. Open the merchant dashboard.
2. Go to **Settings → Integration**, find **Chargebee**, **Connect**.
3. Enter your **Chargebee site / domain** and the API key.
4. Confirm **Connect**.

Copy the **webhook URL** shown after connect for the next step.

## Webhooks

Chargebee can poll/sync on an interval. For near real-time updates, add a webhook:

1. Chargebee **Settings → Configure Chargebee → Webhooks → Add webhook**.
2. Name it and set the URL in this form:

```text theme={null}
https://mapi.zbx.boomfi.xyz/v1/integrations/webhook/Chargebee/<siteID>
```

Use the exact URL provided in the ZBX integration UI if it differs slightly from the pattern above.

3. Turn **off** basic-auth protection, primary-flag-only behaviour, and card data exclusion as directed in the product UI for this integration.
4. Send **all events** (or the set required by support).
5. Create the webhook.

## Custom fields (recommended)

Provision Chargebee custom fields so crypto metadata is searchable and mergeable. Field keys below use the published integration names:

### Customer

| Field name                 | Type             | Label          |
| -------------------------- | ---------------- | -------------- |
| `cf_boomfi_wallet_address` | Single line text | Wallet address |

### Charge / plan price

| Field name                  | Type             | Label    |
| --------------------------- | ---------------- | -------- |
| `cf_boomfi_payment_network` | Single line text | Network  |
| `cf_boomfi_amount`          | Single line text | Amount   |
| `cf_boomfi_currency`        | Single line text | Currency |
| `cf_boomfi_paylink`         | URL              | Paylink  |

Fields are not all strictly required, but provisioning the full set gives the best reporting experience. See Chargebee’s custom field docs for setup.

## Test a payment

1. Complete a test payment on a pay link in the correct environment.
2. Open **Invoices** in Chargebee and confirm payment details landed.

## Subscriptions

When creating Chargebee subscriptions that use ZBX:

1. Ensure the integration is connected.
2. Create products/plans and customers in Chargebee as usual.
3. Avoid auto-charge modes that only apply to card.
4. Confirm invoices show the crypto pay link metadata after sync.

Contact [support](https://support.zbx.boomfi.xyz) if invoice pay links do not appear after connection.

## Related

* [Integrations Overview](/integrations/overview)
* [Payment Links](/payments/paylinks)