Skip to main content
Glama

Chargebee: Record invoice payment

chargebee_record_invoice_payment

Chargebee: Record an offline payment, such as a bank transfer, on an open invoice. Records a payment received outside Chargebee on a payment_due or not_paid invoice. A partial amount reduces the amount due; an amount above it becomes excess payments on the customer. Amounts are in the smallest currency unit. It marks money as received, so by default you confirm each call; you can switch that off for this tool. Reaches other people: confirm with the user before each call. Needs the user's Cotlet API key with access to this app.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateNoDay the money arrived. Default: today.
amountYesAmount received in the smallest currency unit.
commentNoInternal note, for example the bank reference.
invoice_idYesInvoice ID from list_invoices, for example INV-1042.
reason_codeNoA reason code configured in Chargebee, if your site uses them.
payment_methodYesOffline method as named in the Record payment dialog, for example Bank transfer.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false and destructiveHint=false, so the mutation/safety profile is covered. The description goes beyond them by explaining the partial-payment and overpayment outcomes, that the call marks money as received with a default confirmation step, and that it requires a scoped API key, all of which materially affect invocation behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the core action and stays tight overall, but the confirmation guidance is stated twice ('by default you confirm each call' and 'confirm with the user before each call'), which is mild redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no output schema, the description covers the key behaviors an agent needs: what it records, invoice-state constraints, overpayment handling, and the confirmation/permission requirements. Return-value details are not needed and reasonably omitted.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all six parameters are already documented in the schema. The description reinforces the smallest-currency-unit rule for amount but adds no syntax or format detail beyond what the schema provides, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (record an offline payment on an open invoice) and pins the scope to payment_due or not_paid invoices. This clearly distinguishes it from sibling reads like chargebee_get_invoice and chargebee_list_invoices, and from online-payment flows.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear condition for use: recording a payment received outside Chargebee against an open invoice. It does not name a sibling alternative for online payments, but the usage context is unambiguous enough for an agent to select correctly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources