Interface: FirmhouseOrderedProductWithUtils
Properties
createdAt
string | null
The time when the ordered product was created
followsPlanSchedule
() => boolean
Utility to check if the ordered product follows the plan schedule
graceCancellationEndsAt
string | null
The time when the grace cancellation period ends
interval
number | null
The amount of time in units between shipments of this order
intervalUnitOfMeasure
string | null
The time measure for interval units
intervalUnitOfMeasureType
| OrderedProductIntervalUnitOfMeasure | null
The time when the maximum commitment period ends
maximumCommitmentEndsAt
string | null
Metadata makes it possible to store additional information on objects.
minimumCommitmentEndsAt
string | null
Type of ordered products
plan
| { id: string; } | null
If added as part of a plan, this will be the reference.
priceExcludingTaxCents
number | null
The price of the product for this subscription excluding tax in cents
priceIncludingTaxCents
number | null
The price of the product for this subscription including tax in cents
product
The associated product record for this order line
recurring
boolean
Whether this product will get shipped or charged recurringly.
shipmentDate
string | null
The next date on which a new order should get initiated
shipsOnlyOnce
() => boolean
Utility to check if the ordered product is delivered only once
totalAmountExcludingTaxCents
number | null
The total amount based on the unit price * quantity excluding tax, in cents
totalAmountIncludingTaxCents
number | null
The total amount based on the unit price * quantity including tax, in cents
totalOrdered
number | null
The total amount that the customer has ordered of this product upto now
updatedAt
string | null
The time when the ordered product was updated
Last updated
Was this helpful?