For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
Storefront
Types
Objects
CheckoutCoupon
OBJECT
Copy page
The checkout coupon.
Fields
entityId
Integer
Required
The coupon ID.
promotionEntityId
Integer
Required
The ID of the promotion that generated this coupon.
code
String
Required
The coupon code.
discountedAmount
Money
Required
The discounted amount applied within a given context.
Show 4 fields
discountedAmountInDisplayCurrency
Money
Required
Discounted amount in display currency.
Show 4 fields
hasMaxLimitReached
Boolean
Required
Indicates whether the coupon has reached its maximum limit.
couponType
CouponType
Optional
The coupon type.
Show 6 enum values
displayName
String
Optional
The display name of the coupon.
status
CouponStatus
Optional
The status of the coupon.
Allowed values:
APPLIED
STAGED
Referenced by
Fields
Checkout.coupons
CheckoutShippingConsignment.coupons
