TaxRate

A Tax Rate can be used to define a custom rate to charge on specified products, product types, and shipping options within a given region.

Constructors

constructor

**new TaxRate**()

A Tax Rate can be used to define a custom rate to charge on specified products, product types, and shipping options within a given region.

Properties

codenull | stringRequired

A code to identify the tax type by

created_atDateRequired

The date with timezone at which the resource was created.

idstringRequired

The tax rate's ID

metadataRecord<string, unknown>Required

An optional key-value map with additional details

namestringRequired

A human friendly name for the tax

product_countnumber

The count of products

product_type_countnumber

The count of product types

product_typesProductType[]Required

The details of the product types that belong to this tax rate.

productsProduct[]Required

The details of the products that belong to this tax rate.

ratenull | numberRequired

The numeric rate to charge

regionRegionRequired

The details of the region that the rate belongs to.

region_idstringRequired

The ID of the region that the rate belongs to.

shipping_option_countnumber

The count of shipping options

shipping_optionsShippingOption[]Required

The details of the shipping options that belong to this tax rate.

updated_atDateRequired

The date with timezone at which the resource was updated.

Methods

beforeInsert

Private **beforeInsert**(): void

Returns

void

voidvoid