Skip to main content

BillingPaymentTotals

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 BillingPaymentTotals type represents the per-payment cost breakdown, including any base fee and per-unit (e.g., seats) subtotals.

Properties

  • Name
    baseFee?
    Type
    null | BillingMoneyAmount
    Description

    The flat base fee charged on top of any per-unit fees.

  • Name
    discounts?
    Type
    null | BillingDiscounts
    Description

    Discounts applied to this payment such as mid-cycle prorated seat discounts. null when no discounts apply.

  • Name
    grandTotal
    Type
    BillingMoneyAmount
    Description

    The total amount for the payment, including taxes and after credits/discounts are applied.

  • Name
    perUnitTotals?
    Type
    BillingPerUnitTotal[]
    Description

    Per-unit cost breakdown for this payment (e.g., seats).

  • Name
    subtotal
    Type
    BillingMoneyAmount
    Description

    The price of the items before taxes, credits, or discounts are applied.

  • Name
    taxTotal
    Type
    BillingMoneyAmount
    Description

    The amount of tax included in the payment.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub