Sign in
Coupons

Add an offering discount to a coupon

This endpoint adds an offering discount to a coupon.

post/shop/coupons/{couponId}/offering-discounts

Path parameters

couponIdstring object-id required

Identifier of the coupon record. Returned from listCoupons and createCoupon; used to update the coupon, manage its offering discounts, or issue redemption codes.

Request body

discount_type'fixed_amount' | 'percentage' required

The type of discount to be applied

fixed_amountinteger

The amount of discount to apply as an integer of the smallest unit of currency.

percentageinteger

The percentage of discount to apply

Example request

{
  "fixed_amount": 50,
  "percentage": 10
}

Response

The offering discount was successfully retrieved

Example response

{
  "data": {
    "offerings": [
      {
        "offering_name": "Test offering"
      }
    ],
    "fixed_amount": 50,
    "percentage": 10
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.