Skip to main content

BillingCheckoutTotals

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 BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.

Properties

  • Name
    baseFee?
    Type
    BillingMoneyAmount
    Description

    The base plan fee portion of the totals, before per-unit charges and adjustments.

  • Name
    credit
    Type
    null | BillingMoneyAmount
    Description

    Any credits (like account balance or promo credits) that are being applied to the checkout.

  • Name
    discounts?
    Type
    null | BillingDiscounts
    Description

    Discounts applied to this checkout such as mid-cycle prorated seat discounts.

  • Name
    grandTotal
    Type
    BillingMoneyAmount
    Description

    The total amount for the checkout, including taxes and after credits/discounts are applied. This is the final amount due.

  • Name
    pastDue
    Type
    null | BillingMoneyAmount
    Description

    Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.

  • Name
    perUnitTotals?
    Type
    BillingPerUnitTotal[]
    Description

    Per-unit cost breakdown for items actively being purchased in this checkout (for example, seats being added). When only adding seats mid-cycle, this only covers the seats being added, not seats already paid for.

  • Name
    subtotal
    Type
    BillingMoneyAmount
    Description

    The price of items actively being purchased in this checkout, before taxes and discounts. When only adding seats mid-cycle, this reflects just the new seats and excludes the base plan fee and seats that were already paid for.

  • Name
    taxTotal
    Type
    BillingMoneyAmount
    Description

    The amount of tax included in the checkout.

  • Name
    totalDueAfterFreeTrial
    Type
    null | BillingMoneyAmount
    Description

    The amount that becomes due after a free trial ends.

  • Name
    totalDueNow
    Type
    BillingMoneyAmount
    Description

    The amount that needs to be immediately paid to complete the checkout.

  • Name
    totalDuePerPeriod
    Type
    BillingMoneyAmount
    Description

    The amount that will be charged per period for this subscription.

  • Name
    totalsDuePerPeriod?
    Type
    BillingPeriodTotals
    Description

    Full renewal period totals after this checkout completes. Contains the complete breakdown of what the next recurring charge will look like, including all seats and the base plan fee.

Feedback

What did you think of this content?

Last updated on