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