Skip to main content
Glama

get_subscription_payment

Read-only

Retrieve a single subscription payment by ID — one charge within a subscription's billing cycle, not the subscription itself.

Pass livemode: false to read test-mode records.

Use list_subscription_payments first if you need to discover an ID; filter it by subscriptionId to see every payment on one subscription. For the subscription record itself (status, schedule, next billing date), use get_subscription.

If the ID does not exist for the authenticated seller, returns a 404 error: "Subscription payment not found".

Two independent status fields: paymentStatus is the charge outcome (succeeded, pending, failed, incomplete); invoiceStatus is the Stripe invoice lifecycle (draft, open, paid, uncollectible, void). Check both when answering "did this payment go through?".

Example uses:

  • "Why did the March payment on this subscription fail?"

  • "Was this renewal charge refunded?"

  • "Show me the invoice PDF for this subscription payment"

This tool is read-only. Refunds must be performed in the Checkout Page dashboard.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
livemodeNoSet to false to read test-mode records (created while a page was in test mode). Defaults to live records.
subscriptionPaymentIdYesThe ID of the subscription payment to retrieve. Use `list_subscription_payments` first if you need to discover the ID — filter by `subscriptionId` to see every payment on one subscription. This is the ID of a single payment, not the subscription it belongs to.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description isn't carrying the safety burden — yet it still adds real behavior: a 404 with the exact message when the ID doesn't exist for the authenticated seller, test-mode access via livemode:false, and the constraint that refunds cannot be done here (dashboard only). It doesn't discuss rate limits or auth requirements beyond the seller scoping, keeping it just short of a 5.

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-loaded with purpose and scope, then grouped under clear bold headers for error behavior, status fields, and examples. It is on the long side and the three example utterances plus the restated read-only line are marginal, but nearly every sentence carries distinct information.

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

Completeness5/5

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

An output schema exists, so return values need no explanation, yet the description still flags the two independent status fields (paymentStatus vs. invoiceStatus) and that both must be checked when answering 'did this payment go through?' — exactly the kind of domain trap an agent would otherwise get wrong.

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 both parameters are already documented in the schema, including the exact livemode test-mode semantics and the 'not the subscription it belongs to' warning on subscriptionPaymentId. The description largely repeats this, so the baseline 3 applies; it adds no format or syntax detail beyond the schema.

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 ('Retrieve a single subscription payment by ID') and immediately carves out scope: 'one charge within a subscription's billing cycle, not the subscription itself.' An agent can distinguish it from get_subscription and get_payment without opening any schema.

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

Usage Guidelines5/5

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

Explicitly routes to alternatives by name and condition: use `list_subscription_payments` first to discover an ID (filtered by `subscriptionId`), and use `get_subscription` for subscription-level status/schedule/next-billing-date. Both the when-to-use and the when-not-to-use cases are stated.

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