Create Discount
Create a discount for your account.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Request body for creating a discount.
code
is optional; if not provided, we generate a random 16-char code.
The discount amount.
- If
discount_type
is notpercentage
,amount
is in USD cents. For example,100
means$1.00
. Only USD is allowed. - If
discount_type
ispercentage
,amount
is in basis points. For example,540
means5.4%
.
Must be at least 1.
percentage
Optionally supply a code (will be uppercased).
- Must be at least 3 characters if provided.
- If omitted, a random 16-character code is generated.
When the discount expires, if ever.
List of product IDs to restrict usage (if any).
How many times this discount can be used (if any). Must be >= 1 if provided.
Response
The discount amount.
- If
discount_type
ispercentage
, this is in basis points (e.g., 540 => 5.4%). - Otherwise, this is USD cents (e.g., 100 =>
$1.00
).
The business this discount belongs to.
The discount code (up to 16 chars).
Timestamp when the discount is created
The unique discount ID
List of product IDs to which this discount is restricted.
How many times this discount has been used.
percentage
Optional date/time after which discount is expired.
Name for the Discount
Usage limit for this discount, if any.