> ## Documentation Index
> Fetch the complete documentation index at: https://docs.subotiz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Object

Discount entity field reference.

| Field            | Type   | Desc                                                                                                                                                                                                                                                                                                                                       |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| id               | string | The unique ID of the discount object                                                                                                                                                                                                                                                                                                       |
| discount\_name   | string | The name of the discount                                                                                                                                                                                                                                                                                                                   |
| status           | string | Discount status:<br />draft: The discount has been created but is not active or visible to users yet.<br />not\_started: The discount is defined, but its start time has not yet arrived.<br />ongoing: The discount is currently active and available for use.<br />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:<br />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                                                                                                                                                                                                                                                                                                     |