FirmhouseOrderedProductWithUtils
Last updated
Last updated
createdAt
null
| string
The time when the ordered product was created
FirmhouseOrderedProduct
.createdAt
followsPlanSchedule
() => boolean
Utility to check if the ordered product follows the plan schedule
FirmhouseOrderedProductUtils
.followsPlanSchedule
graceCancellationEndsAt
null
| string
The time when the grace cancellation period ends
FirmhouseOrderedProduct
.graceCancellationEndsAt
id
string
ID to identify the ordered product with
interval
null
| number
The amount of time in units between shipments of this order
FirmhouseOrderedProduct
.interval
intervalUnitOfMeasure
null
| string
The time measure for interval units
FirmhouseOrderedProduct
.intervalUnitOfMeasure
intervalUnitOfMeasureType
The time when the maximum commitment period ends
FirmhouseOrderedProduct
.intervalUnitOfMeasureType
maximumCommitmentEndsAt
null
| string
Metadata makes it possible to store additional information on objects.
FirmhouseOrderedProduct
.maximumCommitmentEndsAt
metadata
unknown
The time when the minimum commitment period ends
FirmhouseOrderedProduct
.metadata
minimumCommitmentEndsAt
null
| string
Type of ordered products
FirmhouseOrderedProduct
.minimumCommitmentEndsAt
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
FirmhouseOrderedProduct
.priceExcludingTaxCents
priceIncludingTaxCents
null
| number
The price of the product for this subscription including tax in cents
FirmhouseOrderedProduct
.priceIncludingTaxCents
product
The associated product record for this order line
FirmhouseOrderedProduct
.product
productId
string
The associated product record for this order line
FirmhouseOrderedProduct
.productId
quantity
null
| number
The amount ordered for this product
FirmhouseOrderedProduct
.quantity
recurring
boolean
Whether this product will get shipped or charged recurringly.
FirmhouseOrderedProduct
.recurring
shipmentDate
null
| string
The next date on which a new order should get initiated
FirmhouseOrderedProduct
.shipmentDate
shipsOnlyOnce
() => boolean
Utility to check if the ordered product is delivered only once
FirmhouseOrderedProductUtils
.shipsOnlyOnce
status
-
FirmhouseOrderedProduct
.status
title
null
| string
Name of the product
FirmhouseOrderedProduct
.title
totalAmountExcludingTaxCents
null
| number
The total amount based on the unit price * quantity excluding tax, in cents
FirmhouseOrderedProduct
.totalAmountExcludingTaxCents
totalAmountIncludingTaxCents
null
| number
The total amount based on the unit price * quantity including tax, in cents
FirmhouseOrderedProduct
.totalAmountIncludingTaxCents
totalOrdered
null
| number
The total amount that the customer has ordered of this product upto now
FirmhouseOrderedProduct
.totalOrdered
updatedAt
null
| string
The time when the ordered product was updated
FirmhouseOrderedProduct
.updatedAt