# FirmhouseOrderedProductWithUtils

## Properties

| Property                       | Type                                                                                                                                      | Description                                                                      | Inherited from                                                                                                                      |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `createdAt`                    | `null` \| `string`                                                                                                                        | The time when the ordered product was created                                    | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`createdAt`                      |
| `followsPlanSchedule`          | () => `boolean`                                                                                                                           | <p>Utility to check if the ordered product follows the plan schedule<br><br></p> | [`FirmhouseOrderedProductUtils`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product-utils.md).`followsPlanSchedule` |
| `graceCancellationEndsAt`      | `null` \| `string`                                                                                                                        | The time when the grace cancellation period ends                                 | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`graceCancellationEndsAt`        |
| `id`                           | `string`                                                                                                                                  | ID to identify the ordered product with                                          | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`id`                             |
| `interval`                     | `null` \| `number`                                                                                                                        | The amount of time in units between shipments of this order                      | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`interval`                       |
| `intervalUnitOfMeasure`        | `null` \| `string`                                                                                                                        | The time measure for interval units                                              | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`intervalUnitOfMeasure`          |
| `intervalUnitOfMeasureType`    | `null` \| [`OrderedProductIntervalUnitOfMeasure`](/sdks/firmhouse-sdk/reference/enumerations/ordered-product-interval-unit-of-measure.md) | The time when the maximum commitment period ends                                 | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`intervalUnitOfMeasureType`      |
| `maximumCommitmentEndsAt`      | `null` \| `string`                                                                                                                        | Metadata makes it possible to store additional information on objects.           | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`maximumCommitmentEndsAt`        |
| `metadata`                     | `unknown`                                                                                                                                 | The time when the minimum commitment period ends                                 | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`metadata`                       |
| `minimumCommitmentEndsAt`      | `null` \| `string`                                                                                                                        | Type of ordered products                                                         | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`minimumCommitmentEndsAt`        |
| `plan`                         | `null` \| { `id`: `string`; }                                                                                                             | If added as part of a plan, this will be the reference.                          | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`plan`                           |
| `priceExcludingTaxCents`       | `null` \| `number`                                                                                                                        | The price of the product for this subscription excluding tax in cents            | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`priceExcludingTaxCents`         |
| `priceIncludingTaxCents`       | `null` \| `number`                                                                                                                        | The price of the product for this subscription including tax in cents            | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`priceIncludingTaxCents`         |
| `product`                      | [`FirmhouseProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-product.md)                                                       | The associated product record for this order line                                | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`product`                        |
| `productId`                    | `string`                                                                                                                                  | The associated product record for this order line                                | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`productId`                      |
| `quantity`                     | `null` \| `number`                                                                                                                        | The amount ordered for this product                                              | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`quantity`                       |
| `recurring`                    | `boolean`                                                                                                                                 | Whether this product will get shipped or charged recurringly.                    | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`recurring`                      |
| `shipmentDate`                 | `null` \| `string`                                                                                                                        | The next date on which a new order should get initiated                          | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`shipmentDate`                   |
| `shipsOnlyOnce`                | () => `boolean`                                                                                                                           | <p>Utility to check if the ordered product is delivered only once<br><br></p>    | [`FirmhouseOrderedProductUtils`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product-utils.md).`shipsOnlyOnce`       |
| `status`                       | [`OrderedProductStatus`](/sdks/firmhouse-sdk/reference/enumerations/ordered-product-status.md)                                            | -                                                                                | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`status`                         |
| `title`                        | `null` \| `string`                                                                                                                        | Name of the product                                                              | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`title`                          |
| `totalAmountExcludingTaxCents` | `null` \| `number`                                                                                                                        | The total amount based on the unit price \* quantity excluding tax, in cents     | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`totalAmountExcludingTaxCents`   |
| `totalAmountIncludingTaxCents` | `null` \| `number`                                                                                                                        | The total amount based on the unit price \* quantity including tax, in cents     | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`totalAmountIncludingTaxCents`   |
| `totalOrdered`                 | `null` \| `number`                                                                                                                        | The total amount that the customer has ordered of this product upto now          | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`totalOrdered`                   |
| `updatedAt`                    | `null` \| `string`                                                                                                                        | The time when the ordered product was updated                                    | [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md).`updatedAt`                      |


---

# 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://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product-with-utils.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.