Skip to main content

BillingCredits

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.

The BillingCredits type represents the credits applied to a checkout or payment.

Properties

  • Name
    payer
    Type
    null | BillingPayerCredit
    Description

    The payer credit applied to the transaction. null when no payer credit applies.

  • Name
    proration
    Type
    null | BillingProrationCreditDetail
    Description

    The credit for the unused portion of the current billing cycle. null when no proration credit applies.

  • Name
    total
    Type
    BillingMoneyAmount
    Description

    The total monetary value of all credits applied to the transaction.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub