Billplz (BYOK) — connector documentation
- MCP endpoint:
https://byok-billplz.connectorbay.com/mcp - REST API:
POST https://byok-billplz.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec athttps://byok-billplz.connectorbay.com/openapi.json - Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
- Authentication: your own Billplz API secret key (live), sent in the
X-Upstream-Keyheader of every request (never stored, logged or cached) - Health:
https://byok-billplz.connectorbay.com/health· Tool schemas:https://byok-billplz.connectorbay.com/tools.json - Publisher: Unify Dynamics LLC · connectorbay.com/byok-billplz · agent@connectorbay.com
What Billplz (BYOK) is for
Billplz (BYOK) lets an AI assistant read your own Billplz data through the Billplz API with a key you supply (API secret key (live)). Read-only: 8 tools (list_collections, get_collection, get_bill, list_bill_transactions, list_collection_payment_methods, list_payment_gateways, list_fpx_banks, get_webhook_rank). 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 www.billplz.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Billplz. Billplz 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 Billplz collections are active?"
- "Show Billplz collection inbmmepb"
- "Has Billplz bill 8X0Iyzaw been paid?"
- "Which payment attempts did Billplz bill inbmmepb have?"
- "Which payment methods are enabled on Billplz collection 0idsxnh5?"
- "Which Billplz payment gateways are currently active?"
What it does
list_collections: List collections (containers of bills) with title, status and whether the split header is shown; 15 per page, filter by active or inactive.get_collection: Get one collection by id with title, status and split-header flag; split-rule recipient emails are left out.get_bill: Get one bill by id: state (due, paid or deleted), paid flag, amount and paid amount in cents, due date, description and payment link; payer name, email and phone are left out.list_bill_transactions: List the payment attempts of a bill with status (pending, completed, failed), completion time and payment channel; 15 per page.list_collection_payment_methods: List the payment methods of a collection and whether each is enabled.list_payment_gateways: List supported payment gateway codes (FPX banks, cards, wallets) with their category and whether each is currently available.list_fpx_banks: List FPX bank codes and whether each bank is currently available.get_webhook_rank: Get the account's webhook rank (0.0 highest priority to 10.0 lowest), which sets callback execution priority.
BYOK key
You bring your own Billplz API secret key (live) (https://www.billplz.com/guide/get-your-secret-key). 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 www.billplz.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
- https://www.billplz.com/api (the API this connector calls, with a BYOK key)
Live from the Billplz API (www.billplz.com) with a BYOK key; documentation: https://www.billplz.com/api. 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 Billplz. Billplz 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 Billplz account.
Built for: Worldwide. Languages: English.