Skip to main content
Endpoint:

Authorization

string
required
Example:Authorization | Bearer Paste-Your-API-Key-Here

Path Parameters

string
required
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-83229ad7199b

Response

Successful Response

Main Structure (Root)

integer
Status code from API.
string
Status message that describes the status code.
object
The discount details, including its coupons.

data Structure (Object)

string<uuid>
Discount ID.
integer
Creation time (timestamp in ms).
integer | null
Expiration time (timestamp in ms), or null when the discount does not expire.
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 | null
Minimum purchase amount required to apply the discount. null if not set.
boolean | null
Indicates if the discount is lifetime (true/false) or null.
integer
Total number of coupons available.
number
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 | null
Coupon expiration time (timestamp in ms), or null when it does not expire.
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 account that owns the coupon.