Tax
Configure tax settings, look up rates and codes, manage registrations and thresholds, and calculate tax on a transaction.
https://api.wajub.com/tax/settingsThe Tax API lets you enable and configure tax collection for your team, look up standard
rates and codes by country, register in tax jurisdictions, and calculate tax before
charging a customer. When tax_enabled is true, tax is calculated and recorded
automatically on every transaction — the tax field is included in payment and refund
responses.
Live environment required
Tax endpoints require the sk.… private key and are only available in the live environment.
Key endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /tax/settings | View current tax configuration |
PUT | /tax/settings | Update tax configuration |
GET | /tax/rates | List standard tax rates by country |
POST | /tax/calculate | Calculate tax for a given amount/country |
GET | /tax/reports | Tax collected, by period |
GET | /tax/codes | List tax codes |
GET | /tax/codes/{code} | Retrieve a tax code |
GET | /tax/registrations | List your tax registrations |
POST | /tax/registrations | Add a tax registration |
GET | /tax/registrations/{id} | Retrieve a tax registration |
PUT | /tax/registrations/{id} | Update a tax registration |
DELETE | /tax/registrations/{id} | Remove a tax registration |
GET | /tax/jurisdictions | List supported tax jurisdictions |
GET | /tax/thresholds | List registration thresholds by country |
GET | /tax/thresholds/alerts | Thresholds you're approaching or exceeding |
Customer-level tax IDs are managed separately, under the customer resource:
| Method | Endpoint | Description |
|---|---|---|
GET | /customers/{customer_id}/tax_ids | List a customer's tax IDs |
POST | /customers/{customer_id}/tax_ids | Add a tax ID |
DELETE | /customers/{customer_id}/tax_ids/{id} | Remove a tax ID |
Authentication
Tax requires a private key (sk.…) — public keys cannot access this resource.
See Authentication.
https://api.wajub.com/tax/settingscurl https://api.wajub.com/tax/settings \
-H "Authorization: sk.xxxxxxxxxxxxxxxxxxxxxxxx"{
"code": 200,
"status": "OK",
"settings": {
"tax_enabled": false,
"tax_inclusive": false,
"default_country": "CM",
"tax_id_type": null,
"registration_number": null
}
}