Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-chargebee
[02]
Import
Initialize and use
PYTHON
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)>"
)
)[03]
Tool
Add tools to your agent
python
@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 {})Supported Entities & Actions
Lorem ipsum
Lorem ipsum
| Entity | Actions |\n|--------|---------|\n| Customer | [List](./REFERENCE.md#customer-list), [Get](./REFERENCE.md#customer-get), [Search](./REFERENCE.md#customer-search) |\n| Subscription | [List](./REFERENCE.md#subscription-list), [Get](./REFERENCE.md#subscription-get), [Search](./REFERENCE.md#subscription-search) |\n| Invoice | [List](./REFERENCE.md#invoice-list), [Get](./REFERENCE.md#invoice-get), [Search](./REFERENCE.md#invoice-search) |\n| Credit Note | [List](./REFERENCE.md#credit-note-list), [Get](./REFERENCE.md#credit-note-get), [Search](./REFERENCE.md#credit-note-search) |\n| Coupon | [List](./REFERENCE.md#coupon-list), [Get](./REFERENCE.md#coupon-get), [Search](./REFERENCE.md#coupon-search) |\n| Transaction | [List](./REFERENCE.md#transaction-list), [Get](./REFERENCE.md#transaction-get), [Search](./REFERENCE.md#transaction-search) |\n| Event | [List](./REFERENCE.md#event-list), [Get](./REFERENCE.md#event-get), [Search](./REFERENCE.md#event-search) |\n| Order | [List](./REFERENCE.md#order-list), [Get](./REFERENCE.md#order-get), [Search](./REFERENCE.md#order-search) |\n| Item | [List](./REFERENCE.md#item-list), [Get](./REFERENCE.md#item-get), [Search](./REFERENCE.md#item-search) |\n| Item Price | [List](./REFERENCE.md#item-price-list), [Get](./REFERENCE.md#item-price-get), [Search](./REFERENCE.md#item-price-search) |\n| Payment Source | [List](./REFERENCE.md#payment-source-list), [Get](./REFERENCE.md#payment-source-get), [Search](./REFERENCE.md#payment-source-search) |
Example Prompts
Lorem ipsum
List all active subscriptions - Show me details for a specific customer - List recent invoices - Show me details for a specific subscription - List all coupons - List recent transactions - List recent events - Show me customers with the highest monthly recurring revenue - Which subscriptions are set to cancel in the next 30 days? - List all overdue invoices and their amounts - Analyze subscription churn trends over the past quarter - What are the most popular items by number of subscriptions? - Show me total revenue breakdown by currency - Identify customers with expiring payment sources - Compare subscription plan distribution across item prices - List all credit notes issued in the past month - What is the average subscription lifetime for each plan?
Why Airbyte for AI Agents?
Built for production AI workloads with enterprise-grade reliability
Secure Authentication
Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.
Agent-Native Design
Heading
Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.
Production Ready
Battle-tested connectors with comprehensive error handling, logging, and retry logic.
Open Source
Fully open source under the MIT license. Contribute, customize, and extend freely.
Works with your favorite frameworks
LangChain
CrewAI
LlamaIndex
AutoGen
OpenAI Agents SDK
Claude Agents SDK
Frequently Asked Questions
Didn't find your answer? Please don't hesitate to reach out.
The Chargebee connector supports API key authentication in open source mode, where your Chargebee API key is provided directly as the HTTP Basic username. In hosted mode, credentials are stored securely in Airbyte Cloud using Airbyte client ID and client secret.
Can I use this connector with any AI agent framework?
The connector is compatible with any Python-based AI agent framework including LangChain, LlamaIndex, CrewAI, Pydantic AI, and custom implementations.
Does this connector support write operations?
No, the Chargebee connector currently only supports read operations. Write operations such as creating subscriptions, updating billing addresses, canceling subscriptions, applying coupons, or issuing refunds are not supported at this time.
How is this different from the Airbyte data connector?
Agent connectors are specifically designed for AI agents and LLM applications. They provide natural language interfaces, optimized response formats, and seamless integration with agent frameworks, unlike traditional ETL-focused connectors.
Get started in minutes with our open-source connector.