chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
67f9429293
commit
4fb22e8ba5
@@ -6,13 +6,22 @@ description: >-
|
||||
countries.
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
- 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:
|
||||
type: string
|
||||
description: The region's ID
|
||||
type: string
|
||||
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
||||
name:
|
||||
description: >-
|
||||
@@ -29,6 +38,7 @@ properties:
|
||||
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.
|
||||
@@ -45,6 +55,7 @@ properties:
|
||||
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:
|
||||
@@ -63,11 +74,13 @@ properties:
|
||||
items:
|
||||
$ref: ./Country.yaml
|
||||
tax_provider_id:
|
||||
type: string
|
||||
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: >-
|
||||
@@ -79,27 +92,30 @@ properties:
|
||||
fulfillment_providers:
|
||||
description: >-
|
||||
The Fulfillment Providers that can be used to fulfill orders in the
|
||||
Region. Available if the relation `payment_providers` is expanded.
|
||||
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:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user