Authorization
Example:
Authorization | Bearer Paste-Your-API-Key-HerePath Parameters
A unique identifier obtained when creating a discount. If accessed through the
dashboard, it can be found in the URL on the discount details page.Example:
c9aa143a-53f9-44e7-a9c6-83229ad7199bResponse
Successful ResponseMain Structure (Root)
Status code from API.
Status message that describes the status code.
The discount details, including its coupons.
data Structure (Object)
Discount ID.
Creation time (timestamp in ms).
Expiration time (timestamp in ms), or
null when the discount does not expire.Product-specific discount rules (empty if not applied).
Discount type.
Discount product scope.
Eligible customer scope.
Discount name.
Minimum purchase amount required to apply the discount.
null if not set.Indicates if the discount is lifetime (
true/false) or null.Total number of coupons available.
Discount value.
List of coupons associated with this discount.
coupons Structure (Array Of Object)
Coupon ID (UUID).
Coupon code.
Coupon creation time (timestamp in ms).
Related Discount ID.
End of trial month (if applicable).
Coupon expiration time (timestamp in ms), or
null when it does not expire.Whether the coupon is active (
true or false).Maximum usage limit for the coupon.
Coupon type.
Last updated time (timestamp in ms).
ID of the account that owns the coupon.
