Skip to main content
Glama

Order: Search Billing

get_order_paymentlink_and_billing
Read-onlyIdempotent

[Order] [What it does] Searches authenticated-account order checkout Billing records only; it does not cover subscription or one-time-purchase billing. [When to use] Use when the user needs to look up order-related payment or billing records, such as checking the billing status tied to an order. [When not to use] For subscription or Credits billing/invoices, use get_plan_and_credit_billing. This tool never creates a payment link; use the payment-flow-start tool for that. When related_kind=pbl, related_id is a PBL ID and must never be passed to get_order as dsers_order_id. [How to use] billing_id gives an optional exact lookup (skips the default time window); otherwise start_time/end_time default to the latest 30 days. platforms, statuses, and supplier_platform_id are optional filters; copy supplier_platform_id from list_stores. Paginate with page_number. [Side effects] None; read-only, never creates or modifies any record. [Confirmation] No confirmation required; this tool is read-only and never creates or modifies any record.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_order_paymentlink_and_billing"
  }
}

Input Schema

NameRequiredDescriptionDefault
end_timeNoOptional Unix end timestamp. When billing_id is omitted and both time fields are omitted, defaults to now.
statusesNoOptional billing statuses. Omit to search all statuses. Paste JSON example: ["paid"].
page_sizeNoItems per page, up to 100.
platformsNoOptional billing platforms. Omit to search all platforms. Paste JSON example: ["dsers"].
billing_idNoOptional exact Order Billing ID as a decimal string. When set, the Tool does not inject a default time window. The lookup still searches only order checkout billings.
start_timeNoOptional Unix start timestamp. Ignored as a default window when billing_id is set. When billing_id is omitted and both time fields are omitted, defaults to 30 days before end_time.
page_numberNo1-based page number.
supplier_platform_idNoOptional supplier platform ID as a decimal string. Copy from list_stores supplier_apps[].supplier_platform_id; never use applications[].sales_channel_id.

Output Schema

NameRequiredDescriptionDefault
itemsYesBilling records for this page
paginationYespage_number pagination
toolcall_response_atYesUTC timestamp when the Tool response was returned, formatted as RFC3339.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered by structured data. The description restates read-only twice ("Side effects" and "Confirmation") without adding new behavior, though it does usefully disclose the default 30-day window and that billing_id bypasses it.

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

Conciseness3/5

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

The bracketed section headers are well organized and front-loaded, but the definition wastes space: the read-only guarantee appears verbatim in both the side-effects and confirmation sections, and the pbl-related_id warning references parameters this tool does not accept.

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?

Covers scope, alternatives, filter semantics, time-window defaults, and pagination, and an output schema exists so return values need no explanation. The only real omission is clarifying what the stray PBL note refers to, which slightly undermines an otherwise complete definition.

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 the baseline is 3. The "How to use" section largely restates schema text (time-window defaults, supplier_platform_id copied from list_stores, pagination via page_number) rather than adding interpretation the schema lacks.

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 a precisely scoped resource: "Searches authenticated-account order checkout Billing records only," and immediately excludes subscription and one-time-purchase billing. An agent can distinguish it from get_plan_and_credit_billing and get_order 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 Guidelines4/5

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

Provides explicit when-to-use and when-not-to-use sections naming the correct alternatives (get_plan_and_credit_billing for subscription/Credits, create_order_payment_link for payment links). The guidance is weakened by a note about `related_kind=pbl` and `related_id`, neither of which exists in this tool's input schema, which could mislead an agent into seeking parameters that cannot be passed.

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.