# 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**        | `string`  | The activation date/time of this price list scheduler.                                                                                                                                              |
| attributes.**expires\_at**       | `string`  | 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**      | `string`  | Time at which this resource was disabled.                                                                                                                                                           |
| attributes.**created\_at**       | `string`  | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**       | `string`  | 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.**event\_stores**  | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                    | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.commercelayer.io/core-api-reference/price_list_schedulers/object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.