| Field | Type | Required | Description |
|---|---|---|---|
Object |
CommercePlanObject | ✔️ | String representing the object's type. Objects of the same type share the same value. |
Id |
string | ✔️ | Unique identifier for the plan. |
Name |
string | ✔️ | The name of the plan. |
Fee |
CommerceMoneyResponse | ✔️ | N/A |
AnnualMonthlyFee |
AnnualMonthlyFee | ✔️ | N/A |
AnnualFee |
AnnualFee | ✔️ | N/A |
Description |
string | ✔️ | The description of the plan. |
ProductId |
string | ✔️ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The ID of the product this plan belongs to. |
IsDefault |
bool | ✔️ | Whether this is the default plan. |
IsRecurring |
bool | ✔️ | Whether this is a recurring plan. |
PubliclyVisible |
bool | ✔️ | Whether this plan is publicly visible. |
HasBaseFee |
bool | ✔️ | Whether this plan has a base fee. |
ForPayerType |
string | ✔️ | The payer type this plan is designed for. |
Slug |
string | ✔️ | The URL-friendly slug for the plan. |
AvatarUrl |
string | ✔️ | The URL of the plan's avatar image. |
Features |
List<FeatureResponse> | ➖ | The features included in this plan. |
FreeTrialEnabled |
bool | ✔️ | Whether free trial is enabled for this plan. |
FreeTrialDays |
long | ✔️ | Number of free trial days for this plan. |