Skip to main content

BillingTotals

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 BillingTotals type represents a granular breakdown of the total amount that will be charged, either during checkout or at renewal.

Properties

  • Name
    baseFee
    Type
    null | BillingMoneyAmount
    Description

    Base fee component before per-unit charges and adjustments

  • Name
    credit?
    Type
    null | BillingMoneyAmount
    Description

    Credit amount

  • Name
    credits
    Type
    null | BillingCredits
    Description

    Unified credits breakdown

  • Name
    discounts
    Type
    null | BillingDiscounts
    Description

    Information about the discounts applied to the payment

  • Name
    grandTotal
    Type
    BillingMoneyAmount
    Description

    Grand total amount

  • Name
    pastDue?
    Type
    null | BillingMoneyAmount
    Description

    Past due amount

  • Name
    perUnitTotals?
    Type
    BillingPerUnitTotal[]
    Description

    Per-unit total breakdown (e.g., seats)

  • Name
    subtotal
    Type
    BillingMoneyAmount
    Description

    Subtotal before adjustments

  • Name
    taxTotal
    Type
    BillingMoneyAmount
    Description

    Total tax amount

  • Name
    totalDueAfterFreeTrial?
    Type
    null | BillingMoneyAmount
    Description

    Total amount due after free trial ends

  • Name
    totalDueNow?
    Type
    BillingMoneyAmount
    Description

    Total amount due now

  • Name
    totalDuePerPeriod?
    Type
    BillingMoneyAmount
    Description

    The expected total payment for each future billing period

  • Name
    totalsDuePerPeriod?
    Type
    BillingPeriodTotals
    Description

    Per-period renewal totals, broken down granularly

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub