VoucherCodes
Revoke a VoucherCode
Revokes a VoucherCode, moving it to status revoked and preventing any further redemptions. Existing redemptions remain on the code's history. Used by customer-service teams when a voucher needs to be cancelled (for example after a chargeback on the purchasing order, or in response to a fraud report).
Revoking a code is permanent — there is no unrevoke. To restore spending power to a customer after a mistaken revoke, issue a fresh voucher.
post/shop/voucher-codes/{voucherCodeId}/revoke
Response
The voucher code was successfully revoked.
Example response
{
"data": {
"code": "ABC123XYZ",
"valid_from_date": "2026-01-01T00:00:00+00:00",
"valid_to_date": "2027-01-01T00:00:00+00:00",
"amount": 5000,
"balance": 2500,
"currency": "gbp",
"value": 5000,
"partially_redeemable": true,
"uses_total": 7,
"uses_remaining": 5,
"fulfillment_status": "needs_dispatching",
"voucher_type": {
"name": "Spa Day Gift Voucher"
},
"recipient": {
"name": "Jane Doe",
"email": "jane@example.com"
},
"delivery": {
"method": "post",
"option": {
"name": "First class mail",
"price": 5000,
"revenue_centre": "spa"
}
},
"order": {
"order_ref": "TRY00",
"item_cost": 5000
},
"redemptions": [
{
"amount": 2500
}
],
"created_at": "2025-02-04T12:00:00+01:00",
"issued_at": "2026-01-02T09:00:00+00:00"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.