Interface TaxRateDraft

interface TaxRateDraft {
    amount?: number;
    country: string;
    includedInPrice: boolean;
    key?: string;
    name: string;
    state?: string;
    subRates?: SubRate[];
}

Properties

amount? country includedInPrice key? name state? subRates?

Properties

Optional Readonlyamount

amount?: number

Tax rate. Must be supplied if no subRates are specified. If subRates are specified, this field can be omitted or it must be the sum of amounts of all subRates.

Readonlycountry

country: string

Country in which the tax rate is applied in ISO 3166-1 alpha-2 format.

ReadonlyincludedInPrice

includedInPrice: boolean

If true, tax is included in Embedded Prices or Standalone Prices, and the taxedPrice is present on LineItems. In this case, the totalNet price on TaxedPrice includes the TaxRate.

Optional Readonlykey

key?: string

User-defined unique identifier of the TaxRate.

Readonlyname

name: string

Name of the TaxRate.

Optional Readonlystate

state?: string

State within the country, such as Texas in the United States.

Optional ReadonlysubRates

subRates?: SubRate[]

Used when the total tax is a combination of multiple taxes (for example, local, state/provincial, and/or federal taxes). The total of all subrates must equal the TaxRate amount. These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.

Settings

Member Visibility

On This Page

Properties