docs/ai-agents/connectors/chargebee/README.md
The Chargebee agent connector is a Python package that equips AI agents to interact with Chargebee through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.
Connector for the Chargebee billing and subscription management API. Supports reading subscriptions, customers, invoices, credit notes, coupons, transactions, events, orders, items, item prices, and payment sources. Chargebee is a recurring billing platform that helps SaaS and subscription businesses manage the full subscription lifecycle.
The Chargebee connector is optimized to handle prompts like these.
The Chargebee connector isn't currently able to handle prompts like these.
uv pip install airbyte-agent-chargebee
Connectors can run in open source or hosted mode.
In open source mode, you provide API credentials directly to the connector.
from airbyte_agent_chargebee import ChargebeeConnector
from airbyte_agent_chargebee.models import ChargebeeAuthConfig
connector = ChargebeeConnector(
auth_config=ChargebeeAuthConfig(
api_key="<Your Chargebee API key (used as the HTTP Basic username)>"
)
)
@agent.tool_plain # assumes you're using Pydantic AI
@ChargebeeConnector.tool_utils
async def chargebee_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.
If your Airbyte client can access multiple organizations, also set organization_id.
This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.
from airbyte_agent_chargebee import ChargebeeConnector, AirbyteAuthConfig
connector = ChargebeeConnector(
auth_config=AirbyteAuthConfig(
customer_name="<your_customer_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
@agent.tool_plain # assumes you're using Pydantic AI
@ChargebeeConnector.tool_utils
async def chargebee_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
This connector supports the following entities and actions. For more details, see this connector's full reference documentation.
| Entity | Actions |
|---|---|
| Customer | List, Get, Search |
| Subscription | List, Get, Search |
| Invoice | List, Get, Search |
| Credit Note | List, Get, Search |
| Coupon | List, Get, Search |
| Transaction | List, Get, Search |
| Event | List, Get, Search |
| Order | List, Get, Search |
| Item | List, Get, Search |
| Item Price | List, Get, Search |
| Payment Source | List, Get, Search |
For all authentication options, see the connector's authentication documentation.
See the official Chargebee API reference.