Region
A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.
Properties
id
stringRequiredThe region's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
name
stringRequiredThe name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.
currency_code
stringRequiredThe three character currency code used in the region.
The details of the currency used in the region.
tax_rate
numberRequiredThe tax rate that should be charged on purchases in the Region.
The details of the tax rates used in the region, aside from the default rate.
tax_code
stringRequiredThe tax code used on purchases in the Region. This may be used by other systems for accounting purposes.
gift_cards_taxable
booleanRequiredWhether the gift cards are taxable or not in this region.
Default: true
automatic_taxes
booleanRequiredWhether taxes should be automated in this region.
Default: true
The details of the countries included in this region.
tax_provider_id
null | stringRequiredThe ID of the tax provider used in this region
The details of the tax provider used in the region.
The details of the payment providers that can be used to process payments in the region.
The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
includes_tax
booleanRequiredWhether the prices for the region include tax
Default: false
Was this section helpful?