Start or Stop Charging a Tax - Spotflow Documentation

curl --request PUT \ --url https://api.spotflow.co/api/v1/tax-configurations/{id}/status \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "status": "inactive" } '

{ "id": 12, "taxName": "VAT", "taxType": "percentage", "rate": 7.5, "currency": "NGN", "capAmount": 2000, "thresholdAmount": 0, "regionId": 1, "regionName": "Nigeria", "merchantName": "DEE LLC", "status": "active", "template": false, "templateId": 1 }

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

The unique ID of the tax rule you want to activate or pause.

Example:

12

Body

application/json

status

enum<string>

required

Available options:

active,

inactive

Example:

"inactive"

Response

200 - application/json

Tax status updated successfully.

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