Skip to main content
GET
Get reward option

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Path Parameters

id
string
required

Response

Success

id
string
companyId
integer
rewardName
string
costToRedeem
integer
discountType
enum<string>
Available options:
fixed_amount,
percentage,
free_shipping
discountValue
number
voucherPrefix
string | null
minimumPurchaseAmount
number
expirationPreset
enum<string>
Available options:
NO_EXPIRATION,
SEVEN_DAYS,
THIRTY_DAYS,
NINETY_DAYS,
ONE_YEAR
priceRuleId
string
startsAt
string<date-time>
endsAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>