Skip to main content
Glama

get_subscription

Read-only

Retrieve a single subscription by ID from your Checkout Page account. Pass livemode: false to read test-mode records.

Use list_subscriptions first if you need to discover a subscription ID by customer email, customer name, product title, or order ID.

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

Example uses:

  • "Fetch subscription 6812fe6e9f39b6760576f01c"

  • "Show me the full state of this subscription"

  • "What's the current period end on this subscription?"

This tool is read-only. Cancellation and refund operations must be performed in the Checkout Page dashboard. For cancellation context, use prepare_subscription_cancellation to see eligibility, side effects, and a dashboard link.

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.
subscriptionIdYesThe ID of the subscription to retrieve. Use `list_subscriptions` first if you need to discover the subscription ID by email, name, customer, page, or date range.

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, destructiveHint=false and openWorldHint=false, but the description adds real value: the 404 error behavior for unknown IDs, the livemode test-vs-live distinction, and the explicit statement that cancellation/refunds must happen elsewhere. It stops short of describing pagination or caching, though neither is relevant for a by-ID fetch.

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 the core action, followed by routing guidance, error semantics and examples. The four example utterances are slightly more than needed but each illustrates a distinct use, so the cost is low.

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?

A read-only lookup with an output schema needs little beyond routing and error behavior, both of which are present. An agent has everything required to select and invoke it correctly.

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. The description's 'Pass livemode: false to read test-mode records' largely repeats the schema text, though the example uses add mild illustrative value. 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: 'Retrieve a single subscription by ID from your Checkout Page account.' The singular 'single' paired with the ID requirement clearly distinguishes it from list_subscriptions and get_subscription_payment.

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 the agent: use list_subscriptions to discover an ID, use prepare_subscription_cancellation for cancellation context, and perform cancellation/refunds in the dashboard. Both when-to-use and when-not-to-use are covered.

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