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

BillingSubscriptionItem

@Serializable

data class BillingSubscriptionItem(val id: String, val plan: BillingPlan, val planPeriod: BillingSubscriptionPlanPeriod = BillingSubscriptionPlanPeriod.UNKNOWN, val priceId: String? = null, val status: BillingSubscriptionStatus = BillingSubscriptionStatus.UNKNOWN, val createdAt: Long? = null, val pastDueAt: Long? = null, val periodStart: Long? = null, val periodEnd: Long? = null, val canceledAt: Long? = null, val amount: BillingMoneyAmount? = null, val nextPayment: BillingSubscriptionItemNextPayment? = null, val credit: BillingSubscriptionItemCredit? = null, val credits: BillingCredits? = null, val appliedDiscount: BillingDiscountRedemption? = null, val seats: BillingSubscriptionItemSeats? = null, val isFreeTrial: Boolean = false)

An item in a Billing Subscription.

Constructors

BillingSubscriptionItem

constructor(id: String, plan: BillingPlan, planPeriod: BillingSubscriptionPlanPeriod = BillingSubscriptionPlanPeriod.UNKNOWN, priceId: String? = null, status: BillingSubscriptionStatus = BillingSubscriptionStatus.UNKNOWN, createdAt: Long? = null, pastDueAt: Long? = null, periodStart: Long? = null, periodEnd: Long? = null, canceledAt: Long? = null, amount: BillingMoneyAmount? = null, nextPayment: BillingSubscriptionItemNextPayment? = null, credit: BillingSubscriptionItemCredit? = null, credits: BillingCredits? = null, appliedDiscount: BillingDiscountRedemption? = null, seats: BillingSubscriptionItemSeats? = null, isFreeTrial: Boolean = false)

Properties

val amount: BillingMoneyAmount?

The amount charged for the subscription item.

appliedDiscount

val appliedDiscount: BillingDiscountRedemption?

The active discount applied to this subscription item.

val canceledAt: Long?

The date and time when the subscription item was canceled, as Unix milliseconds. null if the subscription item is not canceled.

@Serializable(with = ZeroMillisAsNullSerializer::class)

val createdAt: Long?

The date and time when the subscription item was created, as Unix milliseconds. null if FAPI omits it.

val credit: BillingSubscriptionItemCredit?

The credit from a previous purchase that is being applied to the subscription item.

val credits: BillingCredits?

The credits applied to this subscription item.

The unique identifier for the subscription item.

val isFreeTrial: Boolean

Whether the subscription item is for a free trial.

val nextPayment: BillingSubscriptionItemNextPayment?

Information about the next payment for this subscription item.

val pastDueAt: Long?

The date and time when the subscription item became past due, as Unix milliseconds. null if the subscription item is not past due.

val periodEnd: Long?

The date and time when the current billing period ends, as Unix milliseconds. null if not set.

@Serializable(with = ZeroMillisAsNullSerializer::class)

val periodStart: Long?

The date and time when the current billing period starts, as Unix milliseconds. null if FAPI omits it.

val plan: BillingPlan

The Plan associated with the subscription item.

val planPeriod: BillingSubscriptionPlanPeriod

The billing period for the subscription item.

val priceId: String?

The ID of the price that this subscription item is associated with.

val seats: BillingSubscriptionItemSeats?

Seat entitlement details for this subscription item. Only set for organization subscription items with seat-based billing.

val status: BillingSubscriptionStatus

The status of the subscription item.