For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • Contact Object
      • Consumer Object
      • Discount Object
      • Item Object
      • Money Object
      • Order Details Object
      • Payment Object
      • Payment Event Object
      • Refund Object
      • Shipping Courier Object
LogoLogo
On this page
  • Attributes
  • Example Discount object
ReferenceData Models

Discount object

Was this page helpful?
Previous

Item Object

Next
Built with

Attributes

AttributeTypeStatusDescription
displayNamestringrequiredA display name for the discount. Limited to 128 characters.
amountMoneyrequiredThe discount amount.

Example Discount object

1{
2  "displayName": "New Customer Coupon",
3  "amount": {
4    "amount": "29.99",
5    "currency": "USD"
6  }
7}