pointsCost. The reward’s purchase type must be Subscription or Both.
Store-credit shops redeem through redeemFlexibleToSubscription instead.
Usage
Parameters
string
required
The ID of a fixed or percentage reward. Get reward IDs from
getShopRewards.string
required
The
id of one of the customer’s subscriptions, from getSubscriptions.Response
boolean
Whether the discount was applied.
object
The created reward record, with
id and discountCode.number
The amount deducted from the customer’s balance.
number
The customer’s remaining balance.
string
The subscription the discount was applied to.
How many orders the discount applies to follows the reward’s own settings. If applying fails, the customer’s balance is not charged.