{"openapi":"3.1.0","info":{"title":"Chargebee Credit Notes (BYOK) API","version":"0.1.0","description":"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...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-chargebee-credit-notes.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-chargebee-credit-notes/docs"},"termsOfService":"https://connectorbay.com/byok-chargebee-credit-notes/terms"},"servers":[{"url":"https://byok-chargebee-credit-notes.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-chargebee-credit-notes/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_credit_notes":{"post":{"operationId":"list_credit_notes","summary":"List Chargebee credit notes with type, reason, status, totals and how much is allocated, refunded or still available. Am","description":"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. Use for \"Which credit notes still have an amount available\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"customer_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only credit notes of this customer id.","title":"Customer Id Is"},"subscription_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only credit notes of this subscription id.","title":"Subscription Id Is"},"reference_invoice_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only credit notes against this invoice id.","title":"Reference Invoice Id Is"},"status_is":{"anyOf":[{"enum":["adjusted","refunded","refund_due","voided"],"type":"string"},{"type":"null"}],"default":null,"description":"Only credit notes in this status.","title":"Status Is"},"type_is":{"anyOf":[{"enum":["adjustment","refundable","store"],"type":"string"},{"type":"null"}],"default":null,"description":"Only credit notes of this type.","title":"Type Is"},"sort_by_desc":{"anyOf":[{"const":"date","type":"string"},{"type":"null"}],"default":null,"description":"Newest first by credit note date.","title":"Sort By Desc"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"}},"required":["site"],"title":"list_credit_notesArguments","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_credit_note":{"post":{"operationId":"get_credit_note","summary":"Get one Chargebee credit note by id: type, reason, status, totals and allocation. Amounts are in the smallest currency u","description":"Get one Chargebee credit note by id: type, reason, status, totals and allocation. Amounts are in the smallest currency unit. Timestamps are Unix seconds. Use for \"What is the status of credit note CN-102\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"credit_note_id":{"description":"Credit note id, for example CN-102.","maxLength":200,"title":"Credit Note Id","type":"string"}},"required":["site","credit_note_id"],"title":"get_credit_noteArguments","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_disputes":{"post":{"operationId":"list_disputes","summary":"List payment disputes Chargebee knows about, with status, type, reason, amount and the transaction disputed. Amounts are","description":"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. Use for \"Which Chargebee payment disputes are still in review\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"status_is":{"anyOf":[{"enum":["initiated","funds_withdrawn","in_review","cancelled","lost","won"],"type":"string"},{"type":"null"}],"default":null,"description":"Only disputes in this status.","title":"Status Is"},"customer_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only disputes of this customer id.","title":"Customer Id Is"},"transaction_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only disputes on this transaction id.","title":"Transaction Id Is"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"}},"required":["site"],"title":"list_disputesArguments","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_dispute":{"post":{"operationId":"get_dispute","summary":"Get one Chargebee payment dispute by id: status, type, reason and amount. Amounts are in the smallest currency unit. Tim","description":"Get one Chargebee payment dispute by id: status, type, reason and amount. Amounts are in the smallest currency unit. Timestamps are Unix seconds. Use for \"What is the status of dispute dsp_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"dispute_id":{"description":"Dispute id.","maxLength":200,"title":"Dispute Id","type":"string"}},"required":["site","dispute_id"],"title":"get_disputeArguments","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_unbilled_charges":{"post":{"operationId":"list_unbilled_charges","summary":"List charges Chargebee has accumulated but not yet invoiced, with period, quantity, amount and description. Amounts are ","description":"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. Use for \"What unbilled charges does subscription sub_1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"subscription_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only charges of this subscription id.","title":"Subscription Id Is"},"customer_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only charges of this customer id.","title":"Customer Id Is"},"is_voided":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list voided charges, false for active ones.","title":"Is Voided"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"}},"required":["site"],"title":"list_unbilled_chargesArguments","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_promotional_credits":{"post":{"operationId":"list_promotional_credits","summary":"List promotional credits given to customers, with type, amount, description and the balance after each. Amounts are in t","description":"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. Use for \"Which promotional credits did I give in Chargebee\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"customer_id_is":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only credits of this customer id.","title":"Customer Id Is"},"type_is":{"anyOf":[{"enum":["increment","decrement"],"type":"string"},{"type":"null"}],"default":null,"description":"Only credits of this type.","title":"Type Is"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maxLength":1000,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'next_offset' value of the previous answer; leave empty for the first page.","title":"Offset"}},"required":["site"],"title":"list_promotional_creditsArguments","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_promotional_credit":{"post":{"operationId":"get_promotional_credit","summary":"Get one promotional credit entry by id. Use for \"Show promotional credit entry cr_1\".","description":"Get one promotional credit entry by id. Use for \"Show promotional credit entry cr_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Chargebee site name, the first part of your site address: 'acme' for acme.chargebee.com (use 'acme-test' for a test site). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"account_credit_id":{"description":"Promotional credit entry id.","maxLength":200,"title":"Account Credit Id","type":"string"}},"required":["site","account_credit_id"],"title":"get_promotional_creditArguments","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}}}}