Orb

The Orb agent connector is a Python package that equips AI agents to interact with Orb 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.

Orb is a usage-based billing platform that enables businesses to implement flexible pricing models, track customer usage, and manage subscriptions. This connector provides access to customers, subscriptions, plans, and invoices for billing analytics and customer management.

Example questions

The Orb connector is optimized to handle prompts like these.

Show me all my customers in Orb
List all active subscriptions
What plans are available?
Show me recent invoices
Show me details for a recent customer
What is the status of a recent subscription?
Show me the pricing details for a plan
Confirm the Stripe ID linked to a customer
What is the payment provider ID for a customer?
List all invoices for a specific customer
List all subscriptions for customer XYZ
Show all active subscriptions for a specific customer
What subscriptions does customer {external_customer_id} have?
Pull all invoices from the last month
Show invoices created after {date}
List all paid invoices for customer {customer_id}
What invoices are in draft status?
Show all issued invoices for subscription {subscription_id}

Unsupported questions

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

Create a new customer in Orb
Update subscription details
Delete a customer record
Send an invoice to a customer
Filter subscriptions by plan name (must filter client-side after listing)
Pull customers billed for specific products (must examine invoice line_items client-side)

Installation

uv pip install airbyte-agent-orb

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_orb import OrbConnector
from airbyte_agent_orb.models import OrbAuthConfig

connector = OrbConnector(
    auth_config=OrbAuthConfig(
        api_key="<Your Orb API key>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@OrbConnector.tool_utils
async def orb_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_orb import OrbConnector, AirbyteAuthConfig

connector = OrbConnector(
    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
@OrbConnector.tool_utils
async def orb_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
Customers	List, Get, Context Store Search
Subscriptions	List, Get, Context Store Search
Plans	List, Get, Context Store Search
Invoices	List, Get, Context Store Search

Authentication

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

Orb API docs

See the official Orb API reference.

Version information

Package version: 0.1.60
Connector version: 0.1.7
Generated with Connector SDK commit SHA: c5258debd165ab701252c1436d4acfb475bf92b9
Changelog: View changelog

Metadata

Release files for airbyte-agent-orb 0.1.60

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for airbyte-agent-orb 0.1.60
File	Size	Uploaded
airbyte_agent_orb-0.1.60.tar.gz	161.6 kB	Apr 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for airbyte-agent-orb 0.1.60
File	Interpreter	ABI	Platform	Reset
airbyte_agent_orb-0.1.60-py3-none-any.whl 188.3 kB Apr 9, 2026	Python 3	none	any	Details

Total release size: 349.8 kB

Release files / airbyte_agent_orb-0.1.60.tar.gz

Download URL	airbyte_agent_orb-0.1.60.tar.gz
Size	161.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`87ecc94685384d40d49ecbbdb14b7ecf06a8ea6fc268ba9e01b7632eae243154`
BLAKE2b-256 checksum How to use checksums	`671460b0ec7049df4d215ee5714e3a9f05e4117045a65cbdc61a1451125c8008`
Upload date	Apr 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.13.12`

Release files / airbyte_agent_orb-0.1.60-py3-none-any.whl

Download URL	airbyte_agent_orb-0.1.60-py3-none-any.whl
Size	188.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`77cb013805371e4aa5c0e4ac8db1ae8d031c5783698b630019ab4d51a189add7`
BLAKE2b-256 checksum How to use checksums	`eea07dd054c69b4568a911167791da4d139fd084298dec5c85087d7cfda1356d`
Upload date	Apr 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.13.12`