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

BillingDiscountRedemption

@Serializable

data class BillingDiscountRedemption(val id: String, val subscriptionItemId: String, val discountId: String, val name: String, val source: BillingDiscountSource = BillingDiscountSource.UNKNOWN, val promoCode: String? = null, val effect: BillingDiscountEffect? = null, val percentOff: Double? = null, val amountOff: BillingMoneyAmount? = null, val amount: BillingMoneyAmount? = null, val cyclesRemaining: Int? = null, val cyclesApplied: Int, val status: BillingDiscountRedemptionStatus? = null, val redeemedAt: Long, val redeemedBy: String? = null)

A discount redemption applied to a subscription item.

Constructors

BillingDiscountRedemption

constructor(id: String, subscriptionItemId: String, discountId: String, name: String, source: BillingDiscountSource = BillingDiscountSource.UNKNOWN, promoCode: String? = null, effect: BillingDiscountEffect? = null, percentOff: Double? = null, amountOff: BillingMoneyAmount? = null, amount: BillingMoneyAmount? = null, cyclesRemaining: Int? = null, cyclesApplied: Int, status: BillingDiscountRedemptionStatus? = null, redeemedAt: Long, redeemedBy: String? = null)

Properties

val amount: BillingMoneyAmount?

The monetary value of the discount applied to the subscription item.

val amountOff: BillingMoneyAmount?

The configured fixed amount off when effect is BillingDiscountEffect.FIXED_AMOUNT.

val cyclesApplied: Int

The number of billing cycles to which the discount has already been applied.

cyclesRemaining

val cyclesRemaining: Int?

The number of billing cycles for which the discount remains active. null means the discount does not expire after a fixed number of cycles.

val discountId: String

The unique identifier of the redeemed discount.

val effect: BillingDiscountEffect?

Whether the discount subtracts a percentage or a fixed amount.

The unique identifier of the discount redemption.

val name: String

The display name of the discount.

val percentOff: Double?

The percentage deducted when effect is BillingDiscountEffect.PERCENTAGE.

val promoCode: String?

The promotion code used to redeem the discount.

val redeemedAt: Long

The date and time when the discount was redeemed, as Unix milliseconds.

val redeemedBy: String?

The identifier of the user who redeemed the discount. null if no user was recorded.

val source: BillingDiscountSource

How the discount was applied to the subscription item.

val status: BillingDiscountRedemptionStatus?

The current status of the discount redemption.

subscriptionItemId

val subscriptionItemId: String

The unique identifier of the subscription item receiving the discount.