Skip to main content

BillingPeriodTotals

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.

Per-period renewal totals, describing what the subscription renewal charge will look like after the current checkout. Unlike the top-level checkout totals (which only reflect the items actively being purchased), this object contains the full renewal breakdown including all seats and the base plan fee.

Properties

  • Name
    baseFee
    Type
    BillingMoneyAmount
    Description

    The base fee for the billing period.

  • Name
    grandTotal
    Type
    BillingMoneyAmount
    Description

    The grand total for the billing period.

  • Name
    perUnitTotals?
    Type
    BillingPerUnitTotal[]
    Description

    Per-unit cost breakdown for the renewal period, covering all units purchased to date (not just the ones being added in this checkout).

  • Name
    subtotal
    Type
    BillingMoneyAmount
    Description

    The subtotal for the billing period.

  • Name
    taxTotal
    Type
    BillingMoneyAmount
    Description

    The tax total for the billing period.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub