Interface: FirmhouseSubscribedPlan

Properties

Property	Type	Description
activatedAt	string | null	The time of subscription activation for the subscribed plan
allowedToCancel	boolean	Whether this subscribed plan is allowed to be cancelled
billingCycleInterval	number | null	The interval at which the billing cycle runs according to the unit set in billingCycleIntervalUnit.
billingCycleIntervalUnit	| BillingCycleIntervalUnit | null	The unit of the interval the billing cycle runs
customInitialAmountCents	number | null	The custom initial amount for this subscription
customRecurringAmountCents	number | null	The custom recurring amount for this subscription
graceCancellationEndsAt	string | null	The date and time when grace cancellation period ends
graceCancellationPeriod	number | null	The amount of time in units for grace cancellation period of the subscribed plan
graceCancellationUnit	CommitmentUnit | null	The time units of measure for grace cancellation period
id	string	The database ID for the subscribed plan
inGraceCancellation	boolean	Whether this subscribed plan is in grace cancellation period
inMinimumCommitment	boolean	Whether this subscribed plan is in minimum commitment period
maximumCommitmentEndsAt	string | null	The time when the maximum commitment will ends and billing for this plan will stop.
maximumCommitmentPeriod	number | null	The maximum commitment period.
maximumCommitmentUnit	| MaximumCommitmentUnit | null	The maximum commitment unit.
minimumCommitmentEndsAt	string | null	The time when minimum commitment period ends
minimumCommitmentPeriod	number | null	The amount of time in units for minimum commitment period of the subscribed plan
minimumCommitmentUnit	CommitmentUnit | null	The time units of measure for minimum commitment period
name	string	Name of the subscribed plan
nextBillingDate	string | null	The moment the next charge will be created (Only for flexbile billing cycle projects)
showInPriceBreakDown	boolean	Whether or not the associated plan is relevant to display in cart price breakdown.
trialPeriodPeriod	number | null	The interval defining trial period length according to the unit set in trialPeriodIntervalUnit.
trialPeriodUnit	CommitmentUnit | null	The unit of the interval defining the trial period length set in trialPeriodInterval
unconsumedContractTermEventCount	number | null	The number of unconsumed contract term events