Skip to main content

Input fields

amount : Int! required

The amount in smallest units of currency.

amountTaxed : Int! required

The amount (excl. tax) that this tax was calculated from, in smallest units of currency.

metadata : JSONString

JSON containing any additional metadata.

rate : Decimal! required

The rate at which tax was applied.

taxType : String! required

The type of tax (e.g. 'VAT').

unitType : TaxUnitType! required

The unit of the tax rate.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "amount": 17, "amountTaxed": 81, "metadata": {"key": "value"}, "rate": "1.0", "taxType": "state-both-itself-only-seat", "unitType": "PROPORTION" }