FirmhouseSubscribedPlan

Properties

Property	Type	Description
activatedAt	null | string	The time of subscription activation for the subscribed plan
allowedToCancel	boolean	Whether this subscribed plan is allowed to be cancelled
billingCycleInterval	null | number	The interval at which the billing cycle runs according to the unit set in billingCycleIntervalUnit.
billingCycleIntervalUnit	null | BillingCycleIntervalUnit	The unit of the interval the billing cycle runs
customInitialAmountCents	null | number	The custom initial amount for this subscription
customRecurringAmountCents	null | number	The custom recurring amount for this subscription
graceCancellationEndsAt	null | string	The date and time when grace cancellation period ends
graceCancellationPeriod	null | number	The amount of time in units for grace cancellation period of the subscribed plan
graceCancellationUnit	null | CommitmentUnit	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	null | string	The time when the maximum commitment will ends and billing for this plan will stop.
maximumCommitmentPeriod	null | number	The maximum commitment period.
maximumCommitmentUnit	null | MaximumCommitmentUnit	The maximum commitment unit.
minimumCommitmentEndsAt	null | string	The time when minimum commitment period ends
minimumCommitmentPeriod	null | number	The amount of time in units for minimum commitment period of the subscribed plan
minimumCommitmentUnit	null | CommitmentUnit	The time units of measure for minimum commitment period
name	string	Name of the subscribed plan
nextBillingDate	null | string	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	null | number	The interval defining trial period length according to the unit set in trialPeriodIntervalUnit.
trialPeriodUnit	null | CommitmentUnit	The unit of the interval defining the trial period length set in trialPeriodInterval
unconsumedContractTermEventCount	null | number	The number of unconsumed contract term events