---
displayed_sidebar: entitiesSidebar
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# 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

<ParameterTypes parameters={[
  {
    "name": "automatic_taxes",
    "type": "`boolean`",
    "description": "Whether taxes should be automated in this region.",
    "optional": false,
    "defaultValue": "true",
    "expandable": false,
    "children": []
  },
  {
    "name": "countries",
    "type": "[Country](Country.mdx)[]",
    "description": "The details of the countries included in this region.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "display_name",
        "type": "`string`",
        "description": "The country name appropriate for display.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`number`",
        "description": "The country's ID",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "iso_2",
        "type": "`string`",
        "description": "The 2 character ISO code of the country in lower case",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "iso_3",
        "type": "`string`",
        "description": "The 2 character ISO code of the country in lower case",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "name",
        "type": "`string`",
        "description": "The normalized country name in upper case.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "num_code",
        "type": "`number`",
        "description": "The numerical ISO code for the country.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "region",
        "type": "[Region](Region.mdx)",
        "description": "The details of the region the country is associated with.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "region_id",
        "type": "``null`` \\| `string`",
        "description": "The region ID this country is associated with.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "created_at",
    "type": "`Date`",
    "description": "The date with timezone at which the resource was created.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "currency",
    "type": "[Currency](Currency.mdx)",
    "description": "The details of the currency used in the region.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "code",
        "type": "`string`",
        "description": "The 3 character ISO code for the currency.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "includes_tax",
        "type": "`boolean`",
        "description": "Whether the currency prices include tax",
        "optional": true,
        "defaultValue": "false",
        "expandable": false,
        "featureFlag": "tax_inclusive_pricing",
        "children": []
      },
      {
        "name": "name",
        "type": "`string`",
        "description": "The written name of the currency",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "symbol",
        "type": "`string`",
        "description": "The symbol used to indicate the currency.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "symbol_native",
        "type": "`string`",
        "description": "The native symbol used to indicate the currency.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "currency_code",
    "type": "`string`",
    "description": "The three character currency code used in the region.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "deleted_at",
    "type": "``null`` \\| `Date`",
    "description": "The date with timezone at which the resource was deleted.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "fulfillment_providers",
    "type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
    "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the fulfillment provider as given by the fulfillment service.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "is_installed",
        "type": "`boolean`",
        "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
        "optional": false,
        "defaultValue": "true",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "gift_cards_taxable",
    "type": "`boolean`",
    "description": "Whether the gift cards are taxable or not in this region.",
    "optional": false,
    "defaultValue": "true",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "The region's ID",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "includes_tax",
    "type": "`boolean`",
    "description": "Whether the prices for the region include tax",
    "optional": false,
    "defaultValue": "false",
    "expandable": false,
    "featureFlag": "tax_inclusive_pricing",
    "children": []
  },
  {
    "name": "metadata",
    "type": "`Record<string, unknown>`",
    "description": "An optional key-value map with additional details",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "name",
    "type": "`string`",
    "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "payment_providers",
    "type": "[PaymentProvider](PaymentProvider.mdx)[]",
    "description": "The details of the payment providers that can be used to process payments in the region.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the payment provider as given by the payment service.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "is_installed",
        "type": "`boolean`",
        "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
        "optional": false,
        "defaultValue": "true",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "tax_code",
    "type": "`string`",
    "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "tax_provider",
    "type": "[TaxProvider](TaxProvider.mdx)",
    "description": "The details of the tax provider used in the region.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the tax provider as given by the tax service.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "is_installed",
        "type": "`boolean`",
        "description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is\\_installed` attribute is set to `false`.",
        "optional": false,
        "defaultValue": "true",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "tax_provider_id",
    "type": "``null`` \\| `string`",
    "description": "The ID of the tax provider used in this region",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "tax_rate",
    "type": "`number`",
    "description": "The tax rate that should be charged on purchases in the Region.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "tax_rates",
    "type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
    "description": "The details of the tax rates used in the region, aside from the default rate.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "updated_at",
    "type": "`Date`",
    "description": "The date with timezone at which the resource was updated.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />