Interface: FirmhousePlan

A plan that customers can subscribe to.

Properties

Property	Type	Description
available	boolean	Whether plan is available to subscribe to
currency	string | null	Currency used for subscriptions assigned to this plan
graceCancellationEnabled	boolean	Whether a grace cancellation period is enabled
graceCancellationPeriod	number	The amount of time in units for grace cancellation period of the plan
graceCancellationUnit	CommitmentUnit	The time units of measure for grace cancellation period
id	string	The database ID for this plan
imageUrl	string | null	URL to image of the plan
initialAmountExcludingTaxCents	number | null	The plan's initial amount excl. tax in cents
initialAmountIncludingTaxCents	number | null	The plan's initial amount incl. tax in cents
instalmentIntervalPeriod	number | null	The amount of interval units between instalments
instalmentIntervalUnit	BaseIntervalUnit | null	The interval unit between instalments
instalments	number | null	Number of instalments.
maximumCommitmentEnabled	boolean | null	Whether a maximum commitment period is enabled.
maximumCommitmentPeriod	number | null	The amount of time in units for maximum commitment period of the plan.
maximumCommitmentUnit	| MaximumCommitmentUnit | null	The time units of measure for maximum commitment period.
metadata	unknown	Metadata makes it possible to store additional information on objects.
minimumCommitmentEnabled	boolean	Whether a minimum commitment period is enabled
minimumCommitmentPeriod	number	The amount of time in units for minimum commitment period of the plan
minimumCommitmentUnit	CommitmentUnit	The time units of measure for minimum commitment period.
monthlyAmountCents	number | null	The price of the plan
monthlyAmountExcludingTaxCents	number | null	The price of the plan excluding tax in cents
monthlyAmountIncludingTaxCents	number | null	The price of the plan including tax in cents
name	string	Name of the plan
planProducts	| { product: FirmhouseProduct; quantity: number; }[] | null	The products that are included in this plan
slug	string	The plan slug
taxAmountCents	number | null	The amount of tax for this plan in cents
taxPercentage	number | null	The tax percentage for this plan