Chargebee Credit Notes (BYOK) — connector documentation
- MCP endpoint:
https://byok-chargebee-credit-notes.connectorbay.com/mcp - REST API:
POST https://byok-chargebee-credit-notes.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec athttps://byok-chargebee-credit-notes.connectorbay.com/openapi.json - Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
- Authentication: your own Chargebee Credit Notes Chargebee API key (a read-only key is enough), sent in the
X-Upstream-Keyheader of every request (never stored, logged or cached) - Health:
https://byok-chargebee-credit-notes.connectorbay.com/health· Tool schemas:https://byok-chargebee-credit-notes.connectorbay.com/tools.json - Publisher: Unify Dynamics LLC · connectorbay.com/byok-chargebee-credit-notes · agent@connectorbay.com
What Chargebee Credit Notes (BYOK) is for
Chargebee Credit Notes (BYOK) lets an AI assistant read your own Chargebee Credit Notes data through the Chargebee Credit Notes API with a key you supply (Chargebee API key (a read-only key is enough)). Read-only: 7 tools (list_credit_notes, get_credit_note, list_disputes, get_dispute, list_unbilled_charges, list_promotional_credits, get_promotional_credit). 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 *.chargebee.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Chargebee Credit Notes. Chargebee Credit Notes 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 credit notes still have an amount available?"
- "What is the status of credit note CN-102?"
- "Which Chargebee payment disputes are still in review?"
- "What is the status of dispute dsp_1?"
- "What unbilled charges does subscription sub_1 have?"
- "Which promotional credits did I give in Chargebee?"
What it does
list_credit_notes: List Chargebee credit notes with type, reason, status, totals and how much is allocated, refunded or still available. Amounts are in the smallest currency unit. Timestamps are Unix seconds.get_credit_note: Get one Chargebee credit note by id: type, reason, status, totals and allocation. Amounts are in the smallest currency unit. Timestamps are Unix seconds.list_disputes: List payment disputes Chargebee knows about, with status, type, reason, amount and the transaction disputed. Amounts are in the smallest currency unit. Timestamps are Unix seconds.get_dispute: Get one Chargebee payment dispute by id: status, type, reason and amount. Amounts are in the smallest currency unit. Timestamps are Unix seconds.list_unbilled_charges: List charges Chargebee has accumulated but not yet invoiced, with period, quantity, amount and description. Amounts are in the smallest currency unit. Timestamps are Unix seconds.list_promotional_credits: List promotional credits given to customers, with type, amount, description and the balance after each. Amounts are in the smallest currency unit. Timestamps are Unix seconds.get_promotional_credit: Get one promotional credit entry by id.
BYOK key
You bring your own Chargebee Credit Notes Chargebee API key (a read-only key is enough) (https://apidocs.chargebee.com/docs/api/auth). 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 *.chargebee.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://apidocs.chargebee.com/docs/api/credit_notes (the API this connector calls, with a BYOK key)
Live from the Chargebee Credit Notes API (*.chargebee.com) with a BYOK key; documentation: https://apidocs.chargebee.com/docs/api/credit_notes. 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 Chargebee Credit Notes. Chargebee Credit Notes 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 Chargebee Credit Notes account.
Built for: Worldwide. Languages: English.