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, Context Store Search
Subscription List, Get, Context Store Search
Invoice List, Get, Context Store Search
Credit Note List, Get, Context Store Search
Coupon List, Get, Context Store Search
Transaction List, Get, Context Store Search
Event List, Get, Context Store Search
Order List, Get, Context Store Search
Item List, Get, Context Store Search
Item Price List, Get, Context Store Search
Payment Source List, Get, Context Store 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.14
  • Connector version: 1.0.1
  • Generated with Connector SDK commit SHA: 3cecc817f060335c13c5d88bc9ad34a4dace961f
  • 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.14.tar.gz (217.6 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.14-py3-none-any.whl (233.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airbyte_agent_chargebee-0.1.14.tar.gz
  • Upload date:
  • Size: 217.6 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.14.tar.gz
Algorithm Hash digest
SHA256 a192356e2737933da6859609e8a9a692d97bf756a36a39cc5acef791a719ed00
MD5 785e211113c8633a1708efe4bf692b35
BLAKE2b-256 0b15e336ed605b7ed9f84fb92594f91b88c630e20a2815ade7d22a0ac22a7df9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_chargebee-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 9b593c5193221891b1d03669dfb5a33262a3cf8457f96333a78e984e7528af2e
MD5 f4c7995367164d8b7032c43ad074e933
BLAKE2b-256 aef378860ea7f6a1fafe5681f851fefd64cfa84ff3efbc173ee4be2833731292

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