v1
latestOpenAPI 3.1.02026-07-2684271522.2 KBRefunds
Update Refund
Updates the reason and/or metadata of an existing refund. Only these two fields can be changed; the refund amount, status, and associated payment cannot be modified after creation. Supplied metadata keys are merged into any existing metadata.
patch/v1/refunds/{refund_id}
Path parameters
refund_idstring required
Example:fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA
Request body
Example request
{
"refund": {
"reason": "duplicate",
"metadata": {
"order_id": "8842",
"channel": "shopify"
}
}
}Response
An envelope wrapping a single refund object.
Example response
{
"refund": {
"refund_id": "fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"amount": 2500,
"created_at": "2026-06-15T14:30:00Z",
"reason": "duplicate",
"status": "pending",
"test_mode": false,
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"reference_type": "acquirer_reference_number",
"reference_status": "available",
"items": [
{}
],
"subscription_id": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"invoice_id": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
}
}