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

BillingAppliedDiscount

@Serializable

data class BillingAppliedDiscount(val amount: BillingMoneyAmount, val discountId: String, val name: String, val effect: BillingDiscountEffect = BillingDiscountEffect.UNKNOWN, val percentOff: Double? = null, val amountOff: BillingMoneyAmount? = null, val promoCode: String? = null, val cyclesRemaining: Int? = null, val durationInCycles: Int? = null)

A catalog discount applied to a checkout or payment.

Constructors

BillingAppliedDiscount

constructor(amount: BillingMoneyAmount, discountId: String, name: String, effect: BillingDiscountEffect = BillingDiscountEffect.UNKNOWN, percentOff: Double? = null, amountOff: BillingMoneyAmount? = null, promoCode: String? = null, cyclesRemaining: Int? = null, durationInCycles: Int? = null)

Properties

val amount: BillingMoneyAmount

The monetary value of the discount applied to the transaction.

val amountOff: BillingMoneyAmount?

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

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 discount.

durationInCycles

val durationInCycles: Int?

The originally configured duration in billing cycles. null means the discount does not expire after a fixed number of cycles.

val effect: BillingDiscountEffect

Whether the discount subtracts a percentage or a fixed amount.

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 apply the discount.