API Reference
API Reference

Object

Discount entity field reference.


FieldTypeDesc
idstringThe unique ID of the discount object
discount_namestringThe name of the discount
statusstringDiscount status:
  • draft: The discount has been created but is not active or visible to users yet.
  • not_started: The discount is defined, but its start time has not yet arrived.
  • ongoing: The discount is currently active and available for use.
  • completed: The discount has ended and is no longer available for use.
discount_codestringDiscount code to be applied at checkout
discount_methodstringDiscount method: Only when set to "discount_code" can a discount code be used:
  • discount_code: Discount by discount code
starts_atstringDiscount start time in UTC format, An empty string means no restriction
ends_atstringDiscount end time in UTC format, An empty string means no restriction
created_atstringCreation time, UTC formatted string
updated_atstringLast update time, UTC formatted string