Skip to main content
GET
Get Tax Settings by Country/Region

Authorizations

Authorization
string
header
required

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

Query Parameters

regionId
integer
required

The unique ID number for the country (e.g., 1 for Nigeria).

Example:

1

Response

200 - application/json

A list of configured tax settings.

id
integer
Example:

12

taxName
string
Example:

"VAT"

taxType
enum<string>
Available options:
flat,
percentage
Example:

"percentage"

rate
number<float>
Example:

7.5

currency
string
Example:

"NGN"

capAmount
number<float>
Example:

2000

thresholdAmount
number<float>
Example:

0

regionId
integer
Example:

1

regionName
string
Example:

"Nigeria"

merchantName
string
Example:

"DEE LLC"

status
enum<string>
Available options:
active,
inactive
Example:

"active"

template
boolean
Example:

false

templateId
integer
Example:

1