Refund status of a checkout session
get_refund_statusSays whether the payment behind a create_checkout_link session was refunded, how much and why. Status: not_paid (nothing to refund), none (paid, not refunded), requested (a refund is under way), under_review (an unused non-USPS label, decided by an operator), declined (the label was scanned, so the carrier refused the refund), partially_refunded or refunded; with amount_paid, amount_refunded, reason (unused_label: the automatic refund of a never-scanned label; other) and the refund policy in force. Unused USPS labels are refunded automatically; this tool only reads, it never starts a refund. SMKlog records only: no carrier call, no quote allowance.
Parameter rules:
session_id is the as_ plus UUID id from create_checkout_link; no order id or email works.
An unknown, malformed or expired id answers session_not_found.
It reports on the checkout get_checkout_status reports.
No names, addresses, emails or card details.
60 checks an hour per client, shared with get_checkout_status.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"session_id": "<session_id>"
},
"name": "get_refund_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| session_id | Yes | The session_id from create_checkout_link. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | Yes | What, if anything, the agent should do now | |
| policy | Yes | The refund policy in force | |
| reason | No | ||
| status | Yes | ||
| currency | Yes | ISO currency, USD | |
| order_id | No | SMKlog order id, the reference for support; null before checkout | |
| session_id | Yes | The session asked about | |
| amount_paid | Yes | USD; 0 while not_paid | |
| requested_at | No | When the automatic unused-label refund was requested, ISO 8601 | |
| amount_refunded | Yes | USD refunded so far |