object
Coupon
Coupon data applied on cart that includes coupon code, coupon type, coupon value, description, title, subtitle etc.
Fields
coupon_amount
FloatThe amount based on cart value.
coupon_applicable_message
StringMessage which is used to display to the customer if the coupon is applied successfully.
coupon_code
StringCoupon code of the coupon applied on cart.
coupon_type
StringType of the coupon applied to cart.
coupon_value
FloatCoupon value of the coupon applied to cart.
description
StringCoupon description of the coupon applied to cart.
end_date
StringEnd date of the coupon on which the coupon expires.
expires_on
StringMessage to display to user for expiry of the coupon .
is_applicable
BooleanFlag to determine where the coupon is applicable to cart or not.
is_applied
BooleanFlag to determine where the coupon is applied to cart or not.
is_bank_offer
BooleanBank offer flag for the coupon if the coupon is applicable for only if payment done by bank or mode specified in coupon.
max_discount_value
FloatMaximum discount value of the coupon applied to cart.
medias
[CartCouponMedias]message
StringCoupon message of the coupon applied to cart.
minimum_cart_value
FloatMinimum cart value of the coupon applied to cart.
offer_text
StringOffer text of the coupon which highligts coupon offer defined while creating coupon .
start_date
StringStart date of the coupon when the coupon will be live for the users to apply on cart.
sub_title
StringCoupon subtitle of the coupon applied to cart which is used to display.
tags
[String]title
StringCoupon Title of the coupon applied denotes name of the coupon.
Was this section helpful?