Parameters
JSON body
Request body
application/jsoncodestringRequiredVoucher code to update (identifier, cannot be changed).
Example
SUMMER2024typestringOptionalNew discount type.
Example
percentagevaluestringOptionalNew discount value.
Example
15usageLimitnumber | nullOptionalNew usage limit. Set to null to remove limit.
One of 2:
Variant 1
number
Variant 2
null
notestringOptionalNew internal note.
activebooleanOptionalNew active status.
isOrderSingletonbooleanOptionalNew singleton flag.
hasValidityPeriodbooleanOptionalUI-only flag from the admin form: when false, validFrom/validTo are cleared regardless of their values.
validFromstring | nullOptionalNew validity start. Set to null to remove.
One of 2:
Variant 1
string
Variant 2
null
validTostring | nullOptionalNew validity end. Set to null to remove.
One of 2:
Variant 1
string
Variant 2
null
costnumber | nullOptionalNew voucher cost (organisation default currency). null = ratio unknown (1:1 fallback on next credit application); 0 = explicitly gifted; positive number = real money equivalent.
One of 2:
Variant 1
number
Variant 2
null