The discount code string that users will enter. Must be unique within the campaign and no more than 255 characters.
typestring
Required
Type of discount: 'percentage' for a percentage-based discount (e.g., 10% off), or 'fixed' for a fixed amount discount (e.g., $10 off).
usesinteger
Maximum number of times the discount code can be used. If not provided, there is no usage limit.
itemsarray
List of item IDs that the discount code applies to. If not provided, the code applies to all items in the campaign.
activeboolean
Required
Whether the discount code is active and can be used immediately.
amountnumber
Required
Discount amount. For 'percentage' type, this is the percentage (e.g., 10 for 10% off). For 'fixed' type, this is the amount in cents (e.g., 1000 for $10.00 off).
campaigninteger
Required
The campaign ID to create the discount code for.
starts_atstring
UTC datetime string when the discount code becomes active (ISO-8601 format). If not provided, the code is active immediately.
expires_atstring
UTC datetime string when the discount code expires (ISO-8601 format). If not provided, the code will not expire.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not