FirmhousePlan
A plan that customers can subscribe to.
Properties
available
boolean
Whether plan is available to subscribe to
currency
null | string
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
The time units of measure for grace cancellation period
id
string
The database ID for this plan
imageUrl
null | string
URL to image of the plan
initialAmountExcludingTaxCents
null | number
The plan's initial amount excl. tax in cents
initialAmountIncludingTaxCents
null | number
The plan's initial amount incl. tax in cents
instalmentIntervalPeriod
null | number
The amount of interval units between instalments
instalmentIntervalUnit
The interval unit between instalments
instalments
null | number
Number of instalments.
maximumCommitmentEnabled
null | boolean
Whether a maximum commitment period is enabled.
maximumCommitmentPeriod
null | number
The amount of time in units for maximum commitment period of the plan.
maximumCommitmentUnit
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
The time units of measure for minimum commitment period.
monthlyAmountCents
null | number
The price of the plan
monthlyAmountExcludingTaxCents
null | number
The price of the plan excluding tax in cents
monthlyAmountIncludingTaxCents
null | number
The price of the plan including tax in cents
name
string
Name of the plan
planProducts
The products that are included in this plan
slug
string
The plan slug
taxAmountCents
null | number
The amount of tax for this plan in cents
taxPercentage
null | number
The tax percentage for this plan
Last updated