Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
APIManagement APICouponsGet a coupon
GET/api/v1/coupons/{id}

Retrieve a single coupon by its ID.

Requires the Coupons:View permission.

Path parameters

idstring· uuidrequired
The coupon ID.

Coupon object

idstring· uuidrequired
The coupon ID.
codestringrequired
The coupon code customers enter at checkout.
discountTypestringrequired
How the discount value is interpreted.
Values:
percentagefixed
discountValuenumberrequired
Percent (0–100) or fixed amount in the store currency.
applicationScopestringrequired
What the coupon applies to.
Values:
packagescategoriesstore
packageScopestring
Whether the coupon applies to all packages or specific ones.
Values:
allspecific
packageIdsstring[]· uuid
Specific packages this coupon applies to.
maxUsesinteger
Maximum total uses, null for unlimited.
maxUsesPerUserinteger
Maximum uses per customer, null for unlimited.
usesintegerrequired
Number of times this coupon has been used.
validFromstring· date-time
Coupon is invalid before this date.
validUntilstring· date-time
Coupon is invalid after this date.
isActivebooleanrequired
Whether the coupon can currently be redeemed.
createdAtstring· date-timerequired
Creation timestamp.
updatedAtstring· date-timerequired
Last update timestamp.
List couponsCreate a coupon