{"openapi":"3.1.0","info":{"title":"Billplz (BYOK) API","version":"0.1.0","description":"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...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-billplz.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-billplz/docs"},"termsOfService":"https://connectorbay.com/byok-billplz/terms"},"servers":[{"url":"https://byok-billplz.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-billplz/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_collections":{"post":{"operationId":"list_collections","summary":"List collections (containers of bills) with title, status and whether the split header is shown; 15 per page, filter by ","description":"List collections (containers of bills) with title, status and whether the split header is shown; 15 per page, filter by active or inactive. Use for \"Which Billplz collections are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (15 records per page).","title":"Page"},"status":{"anyOf":[{"enum":["active","inactive"],"type":"string"},{"type":"null"}],"default":null,"description":"Collection status: active or inactive.","title":"Status"}},"title":"list_collectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_collection":{"post":{"operationId":"get_collection","summary":"Get one collection by id with title, status and split-header flag; split-rule recipient emails are left out. Use for \"Sh","description":"Get one collection by id with title, status and split-header flag; split-rule recipient emails are left out. Use for \"Show Billplz collection inbmmepb\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"collection_id":{"description":"Collection id.","maxLength":200,"title":"Collection Id","type":"string"}},"required":["collection_id"],"title":"get_collectionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_bill":{"post":{"operationId":"get_bill","summary":"Get one bill by id: state (due, paid or deleted), paid flag, amount and paid amount in cents, due date, description and ","description":"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. Use for \"Has Billplz bill 8X0Iyzaw been paid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"bill_id":{"description":"Bill id.","maxLength":200,"title":"Bill Id","type":"string"}},"required":["bill_id"],"title":"get_billArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_bill_transactions":{"post":{"operationId":"list_bill_transactions","summary":"List the payment attempts of a bill with status (pending, completed, failed), completion time and payment channel; 15 pe","description":"List the payment attempts of a bill with status (pending, completed, failed), completion time and payment channel; 15 per page. Use for \"Which payment attempts did Billplz bill inbmmepb have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"bill_id":{"description":"Bill id.","maxLength":200,"title":"Bill Id","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (15 records per page).","title":"Page"},"status":{"anyOf":[{"enum":["pending","completed","failed"],"type":"string"},{"type":"null"}],"default":null,"description":"Transaction status: pending, completed or failed.","title":"Status"}},"required":["bill_id"],"title":"list_bill_transactionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_collection_payment_methods":{"post":{"operationId":"list_collection_payment_methods","summary":"List the payment methods of a collection and whether each is enabled. Use for \"Which payment methods are enabled on Bill","description":"List the payment methods of a collection and whether each is enabled. Use for \"Which payment methods are enabled on Billplz collection 0idsxnh5\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"collection_id":{"description":"Collection id.","maxLength":200,"title":"Collection Id","type":"string"}},"required":["collection_id"],"title":"list_collection_payment_methodsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_payment_gateways":{"post":{"operationId":"list_payment_gateways","summary":"List supported payment gateway codes (FPX banks, cards, wallets) with their category and whether each is currently avail","description":"List supported payment gateway codes (FPX banks, cards, wallets) with their category and whether each is currently available. Use for \"Which Billplz payment gateways are currently active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_payment_gatewaysArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_fpx_banks":{"post":{"operationId":"list_fpx_banks","summary":"List FPX bank codes and whether each bank is currently available. Use for \"Which FPX banks are down right now on Billplz","description":"List FPX bank codes and whether each bank is currently available. Use for \"Which FPX banks are down right now on Billplz\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_fpx_banksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_webhook_rank":{"post":{"operationId":"get_webhook_rank","summary":"Get the account's webhook rank (0.0 highest priority to 10.0 lowest), which sets callback execution priority. Use for \"W","description":"Get the account's webhook rank (0.0 highest priority to 10.0 lowest), which sets callback execution priority. Use for \"What is my Billplz webhook rank\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_webhook_rankArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}