Skip to main content
Glama

list_payments

Retrieve payments from your Whop company with filters by status, product, date range, and pagination.

Instructions

List all payments for your Whop company with optional filters (status, product, date range, pagination).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
company_idNoFilter by company ID (e.g. biz_xxxx). Uses your API key's company by default.
product_idNoFilter by product ID.
plan_idNoFilter by plan ID.
statusNoFilter by payment status.
billing_reasonNoFilter by billing reason.
user_idNoFilter by user ID.
after_dateNoISO 8601 start date filter (e.g. 2024-01-01).
before_dateNoISO 8601 end date filter (e.g. 2024-12-31).
pageNoPage number (default 1).
perNoItems per page (1-100, default 25).
Behavior2/5

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

With no annotations, the description carries full burden. It does not explicitly state that this is a read-only operation, nor does it disclose pagination behavior or any limitations. The word 'list' weakly implies read, but fails to provide safety or side-effect details.

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

Conciseness5/5

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

The description is a single, front-loaded sentence with no redundant words. It efficiently conveys the core action and scope, earning its place without unnecessary detail.

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

Completeness3/5

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

Despite 10 parameters and no output schema, the description is minimal. It does not mention the response format (e.g., paginated list of payment objects) or default ordering. Schema covers parameters, but the lack of output schema and additional behavioral context leaves some gaps.

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 coverage is 100%, so baseline is 3. The description adds no additional meaning beyond labeling filters as 'optional'. The schema already documents each parameter and defaults (e.g., company_id default). No new semantics are provided.

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?

The description clearly states the resource ('payments'), action ('list'), and scope ('for your Whop company'). It distinguishes from siblings like get_payment (singular) and mutation tools. The optional filters are mentioned, reinforcing the purpose.

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

Usage Guidelines3/5

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

The description implies usage for listing multiple payments but provides no explicit guidance on when to use this tool versus alternatives like get_payment for a single payment, or refund_payment for refunds. No exclusions or prerequisites are mentioned.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/furkankoykiran/whop-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server