Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Coupon Usage Result

Represents the response for coupon usage increase and decrease POST method.
Sample Response
1[
2  {
3    "couponCode": "QWERTY",
4    "isSuccess": true,
5    "redemptionLimit": 10,
6    "redemptionLimitPerCustomer": 3,
7    "remainingRedemptionCount": 6,
8    "remainingRedemptionCountForCustomer": 1
9  },
10  {
11    "couponCode": "ABCD",
12    "errorMessage": "Coupon code doesn't exist.",
13    "isSuccess": false
14  }
15]
Property Name Type Description Filter Group and Version Available Version
couponCode String The code of the coupon for which usage has been increased or decreased. Small, 62.0 62.0
redemptionLimit Integer The total number of times customers can redeem the coupon. Small, 62.0 62.0
remainingRedemptionCount Integer The remaining number of times the coupon can be redeemed. Small, 62.0 62.0
redemptionLimitPerCustomer Integer The total number of times each customer can redeem the coupon. Small, 62.0 62.0
remainingRedemptionCountForCustomer Integer The remaining number of times the specified customer can redeem the coupon. Small, 62.0 62.0
isSuccess Boolean Indicates whether the usage of the coupon was successfully increased or decreased. Small, 62.0 62.0
errorMessage String The error message that contains the details of the why the coupon usage wasn’t updated. Small, 62.0 62.0