Backend BillingPlan object
The BillingPlan object is similar to the BillingPlanResource object as it holds information about a Plan, as well as methods for managing it. However, the BillingPlan object is different in that it is used in the Backend API and is not directly accessible from the Frontend API.
Properties
- Name
id- Type
string- Description
The unique identifier for the Plan.
- Name
name- Type
string- Description
The Plan's name.
- Name
slug- Type
string- Description
The URL-friendly identifier of the Plan.
- Name
description- Type
string | null- Description
The Plan's description.
- Name
isDefault- Type
boolean- Description
Whether the Plan is the default Plan.
- Name
isRecurring- Type
boolean- Description
Whether the Plan is recurring.
- Name
hasBaseFee- Type
boolean- Description
Whether the Plan has a base fee.
- Name
publiclyVisible- Type
boolean- Description
Whether the Plan is displayed in the
<PriceTable/>component.
- Name
fee- Type
BillingMoneyAmount | null- Description
The monthly fee.
- Name
annualFee- Type
BillingMoneyAmount | null- Description
The annual fee.
- Name
annualMonthlyFee- Type
BillingMoneyAmount | null- Description
The annual fee on a monthly basis.
- Name
forPayerType- Type
'user' | 'org'- Description
The type of payer.
- Name
features- Type
Feature[]- Description
The Features the Plan offers.
- Name
avatarUrl- Type
string | null- Description
The URL of the Plan's avatar image.
- Name
freeTrialDays- Type
number | null- Description
The number of free trial days.
- Name
freeTrialEnabled- Type
boolean- Description
Whether free trial is enabled.
Feedback
Last updated on