Check a purchase
get_purchase_statusGet the payment, fulfillment, or refund status of an owned Pay & Send or letter-pack purchase.
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": {
"orderId": "<orderId>"
},
"name": "get_purchase_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orderId | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| letters | No | ||
| message | Yes | ||
| orderId | Yes | ||
| currency | Yes | ||
| letterId | No | ||
| mailType | No | ||
| updatedAt | Yes | ||
| amountCents | Yes | ||
| orderStatus | Yes | ||
| perLetterCents | No | ||
| purchaseStatus | Yes | ||
| scheduleMissed | No | ||
| lettersRefunded | No | ||
| lettersRemaining | No | ||
| checkoutExpiresAt | No | ||
| productDescription | Yes | ||
| amountRefundedCents | No | ||
| refundableAmountCents | No |