Skip to main content

BillingDiscountRedemption

Important

Billing regularly introduces new features and UI changes to Clerk's components. If you'd like to remain on a specific version of Clerk's components or SDK, you can follow the steps in the pinning documentation.

A discount redemption applied to a subscription item.

Properties

  • Name
    amount?
    Type
    BillingMoneyAmount
    Description

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

  • Name
    amountOff?
    Type
    BillingMoneyAmount
    Description

    The configured fixed amount off when effect is 'fixed_amount'. This is the discount's configured value, which can differ from the amount actually applied to the transaction.

  • Name
    cyclesApplied
    Type
    number
    Description

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

  • Name
    cyclesRemaining
    Type
    null | number
    Description

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

  • Name
    discountId
    Type
    string
    Description

    The unique identifier of the redeemed discount.

  • Name
    effect?
    Type
    "percentage" | "fixed_amount"
    Description

    Whether the discount subtracts a percentage or a fixed amount.

  • Name
    id
    Type
    string
    Description

    The unique identifier of the discount redemption.

  • Name
    name
    Type
    string
    Description

    The display name of the discount.

  • Name
    percentOff?
    Type
    number
    Description

    The percentage deducted when effect is 'percentage'.

  • Name
    promoCode?
    Type
    string
    Description

    The promotion code used to redeem the discount.

  • Name
    redeemedAt
    Type
    Date
    Description

    The date and time when the discount was redeemed.

  • Name
    redeemedBy
    Type
    null | string
    Description

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

  • Name
    source
    Type
    "promotion" | "manual" | "promo_code"
    Description

    How the discount was applied to the subscription item.

  • Name
    status?
    Type
    "active" | "exhausted" | "removed"
    Description

    The current status of the discount redemption.

  • Name
    subscriptionItemId
    Type
    string
    Description

    The unique identifier of the subscription item receiving the discount.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub