Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
POST/api/v1/coupons

Create a new coupon.

Requires the Coupons:Edit permission.

Body

codestringrequired
The coupon code customers will enter.
discountTypestringrequired
Discount calculation method.
Values:
percentagefixed
discountValuenumberrequired
Percent (0–100) or fixed amount.
applicationScopestringrequired
What the coupon applies to.
Values:
packagescategoriesstore
packageScopestring
Required when applicationScope is packages.
Values:
allspecific
packageIdsstring[]· uuid
Required when packageScope is specific.
maxUsesinteger
Total use cap.
maxUsesPerUserinteger
Per-customer use cap.
validFromstring· date-time
Earliest valid date.
validUntilstring· date-time
Latest valid date.
isActiveboolean
Whether the coupon is enabled. Defaults to true.