The associated plan.
| Field | Type | Required | Description |
|---|---|---|---|
object |
CommerceSubscriptionItemPlanObject | ✔️ | 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 |
Optional<CommerceSubscriptionItemFee> | ✔️ | N/A |
annualMonthlyFee |
Optional<CommerceSubscriptionItemAnnualMonthlyFee> | ✔️ | N/A |
annualFee |
Optional<CommerceSubscriptionItemAnnualFee> | ✔️ | N/A |
description |
Optional<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 |
boolean | ✔️ | Whether this is the default plan. |
isRecurring |
boolean | ✔️ | Whether this is a recurring plan. |
publiclyVisible |
boolean | ✔️ | Whether this plan is publicly visible. |
hasBaseFee |
boolean | ✔️ | 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 |
Optional<String> | ✔️ | The URL of the plan's avatar image. |
features |
List<FeatureResponse> | ➖ | The features included in this plan. |
freeTrialEnabled |
boolean | ✔️ | Whether free trial is enabled for this plan. |
freeTrialDays |
Optional<Long> | ✔️ | Number of free trial days for this plan. |
unitPrices |
List<CommercePlanUnitPrice> | ➖ | Per-unit pricing tiers for this plan (for example, seats) |