tax-rates
Stable. Describes behaviour that is built and covered by tests in this repository.
GET /v1/tax-rates #
The tax Payrudder adds to the invoices it raises, by customer country
Responses
| Status | Meaning | Body |
|---|---|---|
200 | OK | TaxRates |
Example response
{
"rates": [
{
"country": "string",
"name": "string",
"rate_bps": 0
}
]
}curl
curl -X GET https://YOUR-API-ADDRESS/v1/tax-rates \
-H "Authorization: Bearer $PAYRUDDER_API_KEY"PUT /v1/tax-rates #
Replace the tax rates
Payrudder applies the rates as given, exclusive of the price, to the invoices it raises (monthly usage, fees in advance, plan changes) for customers whose country has a rate, or the rate with an empty country. It does not work out what is due where; the rates and their correctness are the tenant's. Invoices of a subscription a provider runs are taxed by the provider.
Request body
| Field | Type | Description |
|---|---|---|
rates | array of object |
Example
{}Responses
| Status | Meaning | Body |
|---|---|---|
200 | OK | TaxRates |
400 | Error envelope | Error |
Example response
{
"rates": [
{
"country": "string",
"name": "string",
"rate_bps": 0
}
]
}curl
curl -X PUT https://YOUR-API-ADDRESS/v1/tax-rates \
-H "Authorization: Bearer $PAYRUDDER_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Models
Error
| Field | Type | Description |
|---|---|---|
error required | object |
TaxRates
| Field | Type | Description |
|---|---|---|
rates required | array of object |
TaxRatesInput
| Field | Type | Description |
|---|---|---|
rates | array of object |