Files
medusa-store/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml
github-actions[bot] 21badd069d chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-03 07:48:54 +00:00

69 lines
1.5 KiB
YAML

type: object
description: The tax region's details.
x-schemaName: AdminTaxRegion
required:
- id
- country_code
- province_code
- metadata
- parent_id
- created_at
- updated_at
- deleted_at
- created_by
- tax_rates
- parent
- children
properties:
id:
type: string
title: id
description: The tax region's ID.
country_code:
type: string
title: country_code
description: The tax region's country code.
example: us
province_code:
type: string
title: province_code
description: The tax region's province code.
metadata:
type: object
description: The tax region's metadata, can hold custom key-value pairs.
parent_id:
type: string
title: parent_id
description: The ID of the parent tax region.
created_at:
type: string
format: date-time
title: created_at
description: The date the tax region was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the tax region was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the tax region was deleted.
created_by:
type: string
title: created_by
description: The ID of the user that created the tax region.
tax_rates:
type: array
description: The tax region's rates.
items:
type: object
parent:
type: object
children:
type: array
description: The tax region's children.
items:
type: object