Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Orb (BYOK) — connector documentation

  • MCP endpoint: https://byok-orb.connectorbay.com/mcp
  • REST API: POST https://byok-orb.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-orb.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Orb Orb API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-orb.connectorbay.com/health · Tool schemas: https://byok-orb.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-orb · agent@connectorbay.com

What Orb (BYOK) is for

Orb (BYOK) lets an AI assistant read your own Orb data through the Orb API with a key you supply (Orb API key). Read-only: 10 tools (list_customers, get_customer, list_subscriptions, get_subscription, list_invoices, get_invoice, list_plans, list_metrics, get_subscription_costs, list_credit_notes). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.withorb.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Orb. Orb and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which customers are set up in Orb?"
  • "Show Orb customer cus_1."
  • "Which Orb subscriptions are active?"
  • "Show Orb subscription sub_1."
  • "Which Orb invoices are issued but unpaid?"
  • "Show the details of Orb invoice inv_1."

What it does

  • list_customers: List billing customers, newest first, with email, currency, timezone, balance and creation time. Paged by cursor.
  • get_customer: Get one customer by Orb id: contact, currency, balance, timezone and collection settings.
  • list_subscriptions: List subscriptions, newest first, with status, plan, customer, start and end dates and the current billing period.
  • get_subscription: Get one subscription by id: status, plan, customer, dates, billing cycle day and payment terms.
  • list_invoices: List invoices, newest issue date first, with number, status, dates, currency and totals. Filter by status, customer, subscription or dates.
  • get_invoice: Get one invoice by id: number, status, dates, currency, subtotal, total, amount due and hosted invoice link.
  • list_plans: List pricing plans, newest first, with name, status, version, currency, net terms and trial config.
  • list_metrics: List billable metrics (usage definitions) with name, description, status and the SQL that defines them.
  • get_subscription_costs: Day-by-day costs of a subscription (subtotal and total per day) for a time window.
  • list_credit_notes: List credit notes, newest first, with number, invoice, type, totals and customer.

BYOK key

You bring your own Orb Orb API key (https://docs.withorb.com/api-reference/authentication). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.withorb.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Orb API (api.withorb.com) with a BYOK key; documentation: https://docs.withorb.com/api-reference. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Orb. Orb and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Orb account.

Built for: Worldwide. Languages: English.