Skip to Content
DocumentationAPI ReferenceBusiness APIModelsCreate Voucher Template Request

CreateVoucherTemplateRequest

Properties

NameTypeDescriptionNotes
template_nameStringName of the template.[default to null]
template_descriptionStringOptional description of the template.[optional] [default to null]
voucher_typeVoucherTemplateTypeType of voucher (percentage, fixed amount, or buy X get Y).[default to null]
discount_valueDoubleDiscount value.[default to null]
min_order_valueDoubleMinimum order value required.[optional] [default to null]
max_discount_amountDoubleMaximum discount amount that can be applied.[optional] [default to null]
usage_limit_per_userIntegerMaximum times each user can use vouchers from this template.[optional] [default to null]
total_usage_limitIntegerTotal usage limit across all vouchers from this template.[optional] [default to null]
valid_fromStringValid from date (ISO datetime string).[optional] [default to null]
valid_untilStringValid until date (ISO datetime string).[optional] [default to null]
applicable_categoriesListCategories where this voucher applies.[optional] [default to null]
applicable_vendorsListVendors where this voucher applies.[optional] [default to null]
excluded_categoriesListCategories where this voucher is excluded.[optional] [default to null]
excluded_vendorsListVendors where this voucher is excluded.[optional] [default to null]
requires_approvalBooleanWhether voucher generation requires approval.[default to null]
auto_approve_limitDoubleAuto-approve vouchers below this amount.[optional] [default to null]
is_activeBooleanWhether the template is active.[default to null]

[Back to Model list] [Back to API list] [Back to README]