Discount Object

attributes id string a unique identifier for the discount object string the value is always discount label string the label of the discount created at timestamp the date the discount was created expiry date timestamp the date the discount will expire currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 the currency of the discount percent off integer the percentage discount applied to the order and/or product subtotal amount off integer the fixed amount discount applied to the order and/or product subtotal shipping amount off integer the fixed amount discount applied to the shipping subtotal shipping percent off integer the percentage discount applied to the shipping subtotal active boolean shows whether the discount is currently active type string the possible values are customer discount , product discount and order discount payments array of strings appendix docid\ kfbmx4q3dxjtduqf75yx1 the payment whitelist for the discount block affiliates boolean shows whether the discount will apply for orders referred by affiliates destinations array of strings ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the country whitelist of the discount condition string the possible values are coupon , vouchers , all orders , item subtotal , order subtotal , item quantity and order quantity applies to string the possible values are all products , selected products and selected categories rule amount integer the amount that has to be met for the discount to activate for example, 100 items in an order or a $100 order value provided if the condition is set to item subtotal , order subtotal , item quantity or order quantity subscription discount duration string determines how the discount will be applied for subscriptions the possible values are forever , once and repeating number of months integer the total number of months the discount will be applied for recurring subscriptions available if subscription discount duration is set to repeating domain string the id of the domain that this discount is valid for coupon string the actual coupon code available if condition is set to coupon coupon max redemptions integer the number of times that the coupon can be redeemed available if condition is set to coupon coupon times redeemed integer the number of times the coupon has been redeemed thus far products array of strings the product ids associated with the discount available if applies to is set to selected products categories object an object containing the product categories that the discount applies to available if applies to is set to selected categories voucher method string the possible values are autogenerated and list available if condition is set to vouchers voucher prefix string the prefix to use when generating the vouchers available if condition is set to vouchers number of vouchers integer the total number of vouchers available if condition is set to vouchers vouchers array of strings the available voucher codes (not redeemed) available if condition is set to vouchers customer string the id of the customer object docid\ x0e6zfnwaym4bwj4a82ex that this discount belongs to available for discounts with type customer discount { "id" "13316518 3fc8 4418 b14f e8efea620d43", "label" "black friday 50% off", "currency" "eur", "percent off" 50, "object" "discount", "amount off" 0, "shipping percent off" 0, "shipping amount off" 0, "active" false, "type" "product discount", "payments" \[ "all" ], "created at" 1669130701, "expiry date" null, "block affiliates" false, "destinations" \[ "worldwide" ], "condition" "coupon", "applies to" "selected products", "rule amount" null, "subscription discount duration" "forever", "number of months" null, "domain" null, "coupon" "blackfriday2022", "coupon max redemptions" 100, "coupon times redeemed" 0, "products" \[ "5a3da42d d007 49e0 937d 8388d45ba05e" ] }