Interface TaxAmount

A tax amount calculated for the order summary.

Checkout Session Private Preview

interface TaxAmount {
    amount: string;
    minorUnitsAmount: number;
    inclusive: boolean;
    displayName: string;
    percentage?: number;
}

Hierarchy (View Summary)

Amount
- TaxAmount

Index

Properties

amount minorUnitsAmount inclusive displayName percentage?

Properties

amount

amount: string

Localized display value, for example $10.00.

minorUnitsAmount

minorUnitsAmount: number

Value in the currency's smallest unit.

inclusive

inclusive: boolean

Whether this tax is included in the subtotal.

displayName

displayName: string

Customer-facing tax name.

`Optional`percentage

percentage?: number

The tax percentage, when available.