Clerk Android API/com.clerk.api.billing/BillingPlan

BillingPlan

@Serializable

data class BillingPlan(val id: String, val name: String, val fee: BillingMoneyAmount? = null, val annualFee: BillingMoneyAmount? = null, val annualMonthlyFee: BillingMoneyAmount? = null, val description: String? = null, val isDefault: Boolean, val isRecurring: Boolean, val hasBaseFee: Boolean, val forPayerType: BillingPayerResourceType = BillingPayerResourceType.UNKNOWN, val publiclyVisible: Boolean, val slug: String, val avatarUrl: String? = null, val features: List<Feature> = emptyList(), val unitPrices: List<BillingPlanUnitPrice>? = null, val availablePrices: List<BillingPlanPrice>? = null, val freeTrialDays: Int? = null, val freeTrialEnabled: Boolean = false)

A Subscription Plan with its details.

Constructors

constructor(id: String, name: String, fee: BillingMoneyAmount? = null, annualFee: BillingMoneyAmount? = null, annualMonthlyFee: BillingMoneyAmount? = null, description: String? = null, isDefault: Boolean, isRecurring: Boolean, hasBaseFee: Boolean, forPayerType: BillingPayerResourceType = BillingPayerResourceType.UNKNOWN, publiclyVisible: Boolean, slug: String, avatarUrl: String? = null, features: List<Feature> = emptyList(), unitPrices: List<BillingPlanUnitPrice>? = null, availablePrices: List<BillingPlanPrice>? = null, freeTrialDays: Int? = null, freeTrialEnabled: Boolean = false)

Properties

val annualFee: BillingMoneyAmount?

The annual price of the Plan, or null if the Plan is not annual.

annualMonthlyFee

val annualMonthlyFee: BillingMoneyAmount?

The effective monthly price when billed annually, or null if the Plan is not annual.

availablePrices

val availablePrices: List<BillingPlanPrice>?

Prices that can be used to check out for this plan, including non-default prices.

val avatarUrl: String?

The URL of the Plan's avatar image, or null if not set.

val description: String?

A short description of what the Plan offers, or null if none is provided.

val features: List<Feature>

The Features the Plan offers.

val fee: BillingMoneyAmount?

The monthly price of the Plan.

val forPayerType: BillingPayerResourceType

Specifies the subscriber type this Plan is designed for.

val freeTrialDays: Int?

The number of days of the free trial for the Plan. null if the Plan does not have a free trial.

freeTrialEnabled

val freeTrialEnabled: Boolean

Whether the Plan has a free trial.

val hasBaseFee: Boolean

Whether the Plan has a base fee.

The unique identifier for the Plan.

val isDefault: Boolean

Whether the Plan is the default Plan.

val isRecurring: Boolean

Whether the Plan is recurring.

val name: String

The name of the Plan.

publiclyVisible

val publiclyVisible: Boolean

Whether the Plan is visible to the public.

val slug: String

The URL-friendly identifier of the Plan.

val unitPrices: List<BillingPlanUnitPrice>?

Per-unit pricing tiers for this Plan (for example, seats).