Skip to main content

Airbyte Chargebee Connector for AI platforms

Project description

Chargebee

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.

Example questions

The Chargebee connector is optimized to handle prompts like these.

  • 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?

Unsupported questions

The Chargebee connector isn't currently able to handle prompts like these.

  • Create a new subscription in Chargebee
  • Update a customer's billing address
  • Cancel a subscription
  • Apply a coupon to a subscription
  • Issue a refund for an invoice

Installation

uv pip install airbyte-agent-chargebee

Usage

Connectors can run in open source or hosted mode.

Open source

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 {})

Hosted

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 {})

Full documentation

Entities and actions

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

Authentication

For all authentication options, see the connector's authentication documentation.

Chargebee API docs

See the official Chargebee API reference.

Version information

  • Package version: 0.1.0
  • Connector version: 1.0.1
  • Generated with Connector SDK commit SHA: b3431b73e8fc55d38ab8e68a9f96fef6278c7440
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_chargebee-0.1.0.tar.gz (207.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_chargebee-0.1.0-py3-none-any.whl (223.8 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_chargebee-0.1.0.tar.gz.

File metadata

  • Download URL: airbyte_agent_chargebee-0.1.0.tar.gz
  • Upload date:
  • Size: 207.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for airbyte_agent_chargebee-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e28b672143a8a48fd2b458af3a2b81c6511e230acb995a6bec0ea6d6746893a8
MD5 cf18dfdf2dfdcf51432854d294838df3
BLAKE2b-256 c6291c29c4a38f9b1ccf29cbc81ddbd8511960ffef5af74c50eaa2dd055c3446

See more details on using hashes here.

File details

Details for the file airbyte_agent_chargebee-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_chargebee-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a81953439cc3c698149abd6df82d188b279c7c3fa19e2983b56ae05d5bd37de7
MD5 d94af514ef098f06417c6f7e394370c6
BLAKE2b-256 52bbdea433d6c5fe36526cefd92b4323ab93b8aa521553fe241c0cfdf2805802

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page