Paid (BYOK) — connector documentation

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

What Paid (BYOK) is for

Paid (BYOK) lets an AI assistant read your own Paid data through the Paid API with a key you supply (Paid API key). Read-only: 11 tools (list_customers, get_customer, list_orders, get_order, list_invoices, get_invoice, list_payments, list_plans, list_products, list_credit_currencies, list_value_metrics). 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.agentpaid.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Paid. Paid 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 Paid customers have churned?"
"Show Paid customer cus_1."
"Which Paid orders are active for customer cus_1?"
"Show Paid order ord_1."
"Which Paid invoices are overdue?"
"Show Paid invoice inv_1."

What it does

list_customers: List customers: name, legal name, website, external ID, creation state, churn status and VAT number. Search by name or filter by status.
get_customer: Get one customer by Paid customer ID.
list_orders: List orders (subscriptions): name, number, customer, dates, terms, order, billed and pending amounts. Filter by customer or status.
get_order: Get one order by Paid order ID: amounts, dates, terms and creation state.
list_invoices: List invoices: number, customer, order, status, payment status, currency, dates, totals, paid and remaining amounts. Filter by customer, order, status or payment status.
get_invoice: Get one invoice by Paid invoice ID: status, dates, totals, tax and remaining amount.
list_payments: List payments: number, customer, invoice, amount in cents, allocated amount, balance, currency, date, type and status.
list_plans: List plans: product, name, supported currencies, default flag, status and archive date.
list_products: List products: name, description, product code, active flag and archive date. Search by name.
list_credit_currencies: List credit currencies (prepaid credit types): name, key, status and description.
list_value_metrics: List value metrics (outcomes you measure for pricing): slug, name, category, unit and monetary conversion.

BYOK key

You bring your own Paid Paid API key (https://app.paid.ai/settings/api-keys). 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.agentpaid.io 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

https://docs.paid.ai/v-2/api-reference/introduction/overview (the API this connector calls, with a BYOK key)

Live from the Paid API (api.agentpaid.io) with a BYOK key; documentation: https://docs.paid.ai/v-2/api-reference/introduction/overview. 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 Paid. Paid 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 Paid account.

Built for: Worldwide. Languages: English.