title: Region
description: >-
  Regions hold settings for how Customers in a given geographical location shop.
  The is, for example, where currencies and tax rates are defined. A Region can
  consist of multiple countries to accomodate common shopping settings across
  countries.
type: object
required:
  - automatic_taxes
  - created_at
  - currency_code
  - deleted_at
  - gift_cards_taxable
  - id
  - metadata
  - name
  - tax_code
  - tax_provider_id
  - tax_rate
  - updated_at
properties:
  id:
    description: The region's ID
    type: string
    example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  name:
    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.
    type: string
    example: EU
  currency_code:
    description: The 3 character currency code that the Region uses.
    type: string
    example: usd
    externalDocs:
      url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
      description: See a list of codes.
  currency:
    description: Available if the relation `currency` is expanded.
    nullable: true
    $ref: ./Currency.yaml
  tax_rate:
    description: The tax rate that should be charged on purchases in the Region.
    type: number
    example: 0
  tax_rates:
    description: >-
      The tax rates that are included in the Region. Available if the relation
      `tax_rates` is expanded.
    type: array
    items:
      $ref: ./TaxRate.yaml
  tax_code:
    description: >-
      The tax code used on purchases in the Region. This may be used by other
      systems for accounting purposes.
    nullable: true
    type: string
    example: null
  gift_cards_taxable:
    description: Whether the gift cards are taxable or not in this region.
    type: boolean
    default: true
  automatic_taxes:
    description: Whether taxes should be automated in this region.
    type: boolean
    default: true
  countries:
    description: >-
      The countries that are included in the Region. Available if the relation
      `countries` is expanded.
    type: array
    items:
      $ref: ./Country.yaml
  tax_provider_id:
    description: The ID of the tax provider used in this region
    nullable: true
    type: string
    example: null
  tax_provider:
    description: Available if the relation `tax_provider` is expanded.
    nullable: true
    $ref: ./TaxProvider.yaml
  payment_providers:
    description: >-
      The Payment Providers that can be used to process Payments in the Region.
      Available if the relation `payment_providers` is expanded.
    type: array
    items:
      $ref: ./PaymentProvider.yaml
  fulfillment_providers:
    description: >-
      The Fulfillment Providers that can be used to fulfill orders in the
      Region. Available if the relation `fulfillment_providers` is expanded.
    type: array
    items:
      $ref: ./FulfillmentProvider.yaml
  includes_tax:
    description: '[EXPERIMENTAL] Does the prices for the region include tax'
    type: boolean
    default: false
  created_at:
    description: The date with timezone at which the resource was created.
    type: string
    format: date-time
  updated_at:
    description: The date with timezone at which the resource was updated.
    type: string
    format: date-time
  deleted_at:
    description: The date with timezone at which the resource was deleted.
    nullable: true
    type: string
    format: date-time
  metadata:
    description: An optional key-value map with additional details
    nullable: true
    type: object
    example:
      car: white