object

Coupon

Coupon data applied on cart that includes coupon code, coupon type, coupon value, description, title, subtitle etc.
Fields
coupon_amount
Float
Discount amount based on cart value. Example: 150.0
coupon_applicable_message
String
Message displayed to the customer when coupon is applied. Example: 'Coupon applied successfully'
coupon_code
String
Coupon code. Example: 'SAVE10'
coupon_id
String
Unique identifier of the coupon applied to cart.
coupon_type
String
Type of the coupon. Example: 'percentage'
coupon_value
Float
Coupon value. Example: 10.0
description
String
Description of the coupon. Example: '10% off on orders above ₹999'
end_date
String
End date of the coupon. Example: '2025-12-31'
expires_on
String
Expiry message. Example: 'Expires soon'
expires_at
String
Represents the last valid timeslot date on which the coupon can be applied in ISO 8601 (UTC Z) format,based on its configured schedule. If the coupon is restricted to specific days (e.g., Mondays and Thursdays), the expiry date will be the last eligible day within the overall end date range, not necessarily the end date itself.
is_applicable
Boolean
Whether the coupon is applicable to the cart. Example: true
is_applied
Boolean
Whether the coupon is applied to the cart. Example: false
is_bank_offer
Boolean
Whether this is a bank/payment mode specific offer. Example: false
max_discount_value
Float
Maximum discount value allowed. Example: 500.0
message
String
Coupon message to show to the user. Example: 'Applicable on orders above ₹999'
minimum_cart_value
Float
Minimum cart value required. Example: 999.0
offer_text
String
Offer text highlighting the coupon. Example: 'Save 10% today'
start_date
String
Start date of the coupon. Example: '2025-10-01'
sub_title
String
Coupon subtitle used for display. Example: 'Limited time offer'
title
String
Coupon Title (name of the coupon). Example: 'SAVE10'
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