# The price list scheduler object

A price list scheduler object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/price_list_schedulers` endpoint.

## Fields

| Field                            | Type       | Description                                                                                                                                                                                         |
| -------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                         | `string`   | `price_list_schedulers`                                                                                                                                                                             |
| **id**                           | `string`   | The price list scheduler unique identifier                                                                                                                                                          |
| links.**self**                   | `string`   | The price list scheduler endpoint URL                                                                                                                                                               |
| attributes.**name**              | `string`   | The price list scheduler's internal name.                                                                                                                                                           |
| attributes.**starts\_at**        | `datetime` | The activation date/time of this price list scheduler.                                                                                                                                              |
| attributes.**expires\_at**       | `datetime` | The expiration date/time of this price list scheduler (must be after starts\_at).                                                                                                                   |
| attributes.**active**            | `boolean`  | Indicates if the price list scheduler is active (enabled and not expired).                                                                                                                          |
| attributes.**status**            | `string`   | The price list scheduler status. One of 'disabled', 'expired', 'pending', or 'active'.                                                                                                              |
| attributes.**\_disable**         | `boolean`  | Send this attribute if you want to mark this resource as disabled.                                                                                                                                  |
| attributes.**\_enable**          | `boolean`  | Send this attribute if you want to mark this resource as enabled.                                                                                                                                   |
| attributes.**disabled\_at**      | `datetime` | Time at which this resource was disabled.                                                                                                                                                           |
| attributes.**created\_at**       | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**       | `datetime` | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**         | `string`   | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin** | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**          | `object`   | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| relationships.**market**         | `object`   | The associated market.                                                                                                                                                                              |
| relationships.**price\_list**    | `object`   | The associated price list.                                                                                                                                                                          |
| relationships.**events**         | `array`    | The associated events.                                                                                                                                                                              |
| relationships.**versions**       | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**  | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                    | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |