Skip to main content

BillingAppliedDiscount

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 catalog discount applied to a checkout or payment.

Properties

  • Name
    amount
    Type
    BillingMoneyAmount
    Description

    The monetary value of the discount applied to the transaction.

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

  • Name
    durationInCycles?
    Type
    null | number
    Description

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

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

    Whether the discount subtracts a percentage or a fixed amount.

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub