Skip to main content
GET
/
v1
/
tax_protocol
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/tax_protocol \
  --header 'Authorization: Bearer <token>'
{
  "id": "fa291056-1036-47fd-9114-8e86625e342d",
  "object": "tax_protocol",
  "ca_tax_enabled": false,
  "eu_micro_exemption_enabled": false,
  "eu_tax_enabled": false,
  "eu_vat_required": false,
  "eu_vat_unverified_behavior": "error",
  "eu_vat_local_reverse_charge": false,
  "tax_behavior": "exclusive",
  "tax_enabled": false,
  "default_tax_enabled": false,
  "default_rate": null,
  "address": "dd9ed4c6-d96a-48a8-8c86-d541e5b48f90",
  "ca_tax_identifier": null,
  "eu_tax_identifier": null,
  "created_at": 1767909782,
  "updated_at": 1767909782
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
ca_tax_enabled
boolean

If set to true GST taxes will be calculated for all Canadian provinces.

​
default_rate
number | null

The default tax rate to use for checkouts when a specific tax_registration is not found. This will only apply if default_tax_enabled=true.

​
default_tax_enabled
boolean

Whether or not to use the default_rate when a specific tax_registration is not found.

​
eu_micro_exemption_enabled
boolean

If set to true VAT taxes will be calculated using the account's home country VAT rate.

​
eu_tax_enabled
boolean

If set to true VAT taxes will be calculated for all EU countries.

​
tax_behavior
string

Determines how taxes will be calculated. One of exclusive or inclusive.

​
tax_enabled
boolean

If set to true taxes will be automatically calculated.

​
eu_vat_required
boolean

Whether or not an eu_vat tax identifier is required when a customer's address is in the EU.

​
eu_vat_unverified_behavior
string

Determines how eu_vat tax identifiers will be handled when they are not verified against VIES. One of apply_reverse_charge, error, or skip_reverse_charge.

​
eu_vat_local_reverse_charge
boolean

Whether or not reverse charge should be applied when the customer's address is in the same country as the tax protocol address.

​
address

The address used for tax calculations.

Expandable – The associated address ID.

​
ca_tax_identifier

The Canadian tax identifier.

Expandable – The associated ca tax identifier ID.

​
eu_tax_identifier

The EU tax identifier.

Expandable – The associated eu tax identifier ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.