API Reference
API Reference

Object


Field

Type

Desc

id

string

The unique ID of the discount object

discount_name

string

The name of the discount

status

string

Discount 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_code

string

Discount code to be applied at checkout

discount_method

string

Discount method: Only when set to "discount_code" can a discount code be used:

  • discount_code: Discount by discount code

starts_at

string

Discount start time in UTC format, An empty string means no restriction

ends_at

string

Discount end time in UTC format, An empty string means no restriction

created_at

string

Creation time, UTC formatted string

updated_at

string

Last update time, UTC formatted string