Interface TaxRate

Shape of the value for addTaxRate and removeTaxRate actions

interface TaxRate {
    amount: number;
    country: string;
    id: string;
    includedInPrice: boolean;
    name: string;
    state: string;
    subRates: SubRate[];
}

Properties

amount country id includedInPrice name state subRates

Properties

Readonly amount

amount: number

Percentage in the range of [0..1]. The sum of the amounts of all subRates, if there are any.

Readonly country

country: string

Two-digit country code as per ISO 3166-1 alpha-2.

Readonly id

id: string

The ID is always set if the tax rate is part of a TaxCategory. The external tax rates in a Cart do not contain an id.

Readonly includedInPrice

includedInPrice: boolean

Readonly name

name: string

Readonly state

state: string

The state in the country

Readonly subRates

subRates: SubRate[]

Settings

Member Visibility

Theme

On This Page

amountcountryidincludedInPricenamestatesubRates