object

Coupon

Coupon data applied on cart that includes coupon code, coupon type, coupon value, description, title, subtitle etc.
Fields
coupon_amount
Float
The amount based on cart value.
coupon_applicable_message
String
Message which is used to display to the customer if the coupon is applied successfully.
coupon_code
String
Coupon code of the coupon applied on cart.
coupon_type
String
Type of the coupon applied to cart.
coupon_value
Float
Coupon value of the coupon applied to cart.
description
String
Coupon description of the coupon applied to cart.
end_date
String
End date of the coupon on which the coupon expires.
expires_on
String
Message to display to user for expiry of the coupon .
is_applicable
Boolean
Flag to determine where the coupon is applicable to cart or not.
is_applied
Boolean
Flag to determine where the coupon is applied to cart or not.
is_bank_offer
Boolean
Bank 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
Float
Maximum discount value of the coupon applied to cart.
message
String
Coupon message of the coupon applied to cart.
minimum_cart_value
Float
Minimum cart value of the coupon applied to cart.
offer_text
String
Offer text of the coupon which highligts coupon offer defined while creating coupon .
start_date
String
Start date of the coupon when the coupon will be live for the users to apply on cart.
sub_title
String
Coupon subtitle of the coupon applied to cart which is used to display.
title
String
Coupon Title of the coupon applied denotes name of the coupon.
List of discounted rules of coupon