Skip to main content
Skip to main content

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

idstringRequired
The tax rate's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
ratenull | numberRequired
The numeric rate to charge
codenull | stringRequired
A code to identify the tax type by
namestringRequired
A human friendly name for the tax
region_idstringRequired
The ID of the region that the rate belongs to.
regionRegionRequired
The details of the region that the rate belongs to.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
productsProduct[]Required
The details of the products that belong to this tax rate.
product_typesProductType[]Required
The details of the product types that belong to this tax rate.
shipping_optionsShippingOption[]Required
The details of the shipping options that belong to this tax rate.
product_countnumber
The count of products
product_type_countnumber
The count of product types
shipping_option_countnumber
The count of shipping options
Was this section helpful?