# FirmhouseOrderedProduct

## Extended by

* [`FirmhouseOrderedProductWithUtils`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product-with-utils)

## Properties

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