# The in stock subscription object

An in stock subscription object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/in_stock_subscriptions` endpoint.

## Fields

| Field                            | Type       | Description                                                                                                                                                                                         |
| -------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                         | `string`   | `in_stock_subscriptions`                                                                                                                                                                            |
| **id**                           | `string`   | The in stock subscription unique identifier                                                                                                                                                         |
| links.**self**                   | `string`   | The in stock subscription endpoint URL                                                                                                                                                              |
| attributes.**status**            | `string`   | The subscription status. One of 'active' (default), 'inactive', or 'notified'.                                                                                                                      |
| attributes.**customer\_email**   | `string`   | The email of the associated customer, replace the relationship.                                                                                                                                     |
| attributes.**sku\_code**         | `string`   | The code of the associated SKU, replace the relationship.                                                                                                                                           |
| attributes.**stock\_threshold**  | `integer`  | The threshold at which to trigger the back in stock notification.                                                                                                                                   |
| attributes.**\_activate**        | `boolean`  | Send this attribute if you want to activate an inactive subscription.                                                                                                                               |
| attributes.**\_deactivate**      | `boolean`  | Send this attribute if you want to dactivate an active subscription.                                                                                                                                |
| 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.**customer**       | `object`   | The associated customer.                                                                                                                                                                            |
| relationships.**sku**            | `object`   | The associated SKU.                                                                                                                                                                                 |
| 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`)                                                                                                                                           |


---

# 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/in_stock_subscriptions/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.