Retrieve a tax

get /api/taxes/{id}

Retrieves a Tax resource.

Returns a single tax by id, including its rate, translatable name and description, and the country it applies to.

Headers

Name	Type	Required	Description
Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Path parameters

Name	Type	Required	Description
id	string	required	Tax identifier

Query parameters

Name	Type	Required	Description
expand	string	-	Comma-separated list of relations to embed as full objects instead of IRI strings. Supported values: country. Unknown values are silently ignored.
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

Response

200 - Tax resource

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
country	string | Country | null	required	The Country to which this tax belongs. Requires the instance_params:read scope. Returned null when the scope is missing.
createdAt	string	-	The date and time when the resource was created (ISO 8601 format).
description	string | null	-	This property supports translations. A short description of the tax.
id	string	-	The resource's unique identifier (UUID).
name	string | null	-	This property supports translations. The name of the tax.
rate	string	-	The tax rate as a percentage between 0 and 100, serialized as a decimal string with exactly two decimals (e.g. "20.00", "5.50") so that no floating-point rounding can alter it. Parse it with a decimal type, not a float.
updatedAt	string	-	The date and time when the resource was last modified (ISO 8601 format).

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-

404 - Not found

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.