Coupon data applied on cart that includes coupon code, coupon type, coupon value, description, title, subtitle etc.
Fields
coupon_amount
FloatDiscount amount based on cart value. Example: 150.0
coupon_applicable_message
StringMessage displayed to the customer when coupon is applied. Example: 'Coupon applied successfully'
coupon_code
StringCoupon code. Example: 'SAVE10'
coupon_id
StringUnique identifier of the coupon applied to cart.
coupon_type
StringType of the coupon. Example: 'percentage'
coupon_value
FloatCoupon value. Example: 10.0
description
StringDescription of the coupon. Example: '10% off on orders above ₹999'
end_date
StringEnd date of the coupon. Example: '2025-12-31'
expires_on
StringExpiry message. Example: 'Expires soon'
is_applicable
BooleanWhether the coupon is applicable to the cart. Example: true
is_applied
BooleanWhether the coupon is applied to the cart. Example: false
is_bank_offer
BooleanWhether this is a bank/payment mode specific offer. Example: false
max_discount_value
FloatMaximum discount value allowed. Example: 500.0
message
StringCoupon message to show to the user. Example: 'Applicable on orders above ₹999'
minimum_cart_value
FloatMinimum cart value required. Example: 999.0
offer_text
StringOffer text highlighting the coupon. Example: 'Save 10% today'
start_date
StringStart date of the coupon. Example: '2025-10-01'
sub_title
StringCoupon subtitle used for display. Example: 'Limited time offer'
title
StringCoupon Title (name of the coupon). Example: 'SAVE10'
rule
[DiscountRules]List of discounted rules of coupon. Example: [{ discounted_price: 1499.0 }]
custom_fields
[CustomField]Additional custom attributes associated with the coupon for extended functionality and metadata storage
Was this section helpful?