# The order subscription item object

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

## Fields

| Field                                   | Type      | Description                                                                                                                                                                                         |
| --------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                | `string`  | `order_subscription_items`                                                                                                                                                                          |
| **id**                                  | `string`  | The order subscription item unique identifier                                                                                                                                                       |
| links.**self**                          | `string`  | The order subscription item endpoint URL                                                                                                                                                            |
| attributes.**sku\_code**                | `string`  | The code of the associated SKU.                                                                                                                                                                     |
| attributes.**bundle\_code**             | `string`  | The code of the associated bundle.                                                                                                                                                                  |
| attributes.**quantity**                 | `integer` | The subscription item quantity.                                                                                                                                                                     |
| attributes.**unit\_amount\_cents**      | `integer` | The unit amount of the subscription item, in cents.                                                                                                                                                 |
| attributes.**unit\_amount\_float**      | `float`   | The unit amount of the subscription item, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.                                          |
| attributes.**formatted\_unit\_amount**  | `string`  | The unit amount of the subscription item, formatted. This can be useful to display the amount with currency in you views.                                                                           |
| attributes.**total\_amount\_cents**     | `integer` | Calculated as unit amount x quantity amount, in cents.                                                                                                                                              |
| attributes.**total\_amount\_float**     | `float`   | Calculated as unit amount x quantity amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.                                       |
| attributes.**formatted\_total\_amount** | `string`  | Calculated as unit amount x quantity amount, formatted. This can be useful to display the amount with currency in you views.                                                                        |
| 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.**order\_subscription**   | `object`  | The associated order subscription.                                                                                                                                                                  |
| relationships.**item**                  | `object`  | The polymorphic item associated to the subscription item. One of 'skus', 'bundles', or 'adjustments'.                                                                                               |
| relationships.**sku**                   | `object`  | The associated sku item.                                                                                                                                                                            |
| relationships.**bundle**                | `object`  | The associated bundle item.                                                                                                                                                                         |
| relationships.**adjustment**            | `object`  | The associated adjustment item.                                                                                                                                                                     |
| relationships.**source\_line\_item**    | `object`  | The source line item which generated the subscription item.                                                                                                                                         |
| 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/order_subscription_items/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.
