Create tax rate rule

Create custom tax rate rules for a specific app.

⚠️

Note: After you set a tax rate for a specific app + country, ROI360 stops applying default tax updates for that combination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

App ID of the app for which you are setting the tax rate rule

Body Params
taxes
array of objects
length ≥ 1
taxes
string
required

Name appearing in the customer invoice that describes the specific type of tax, such as sales, VAT, GST 

float
required

Number up to 4 decimal places representing the tax percentage to be collected

boolean
Defaults to false

Boolean parameter, either true or false. False means tax is included in the overall revenue. True means tax is in addition to the overall stated revenue. For example, in the USA or Canada, where the sticker price doesn't include sales tax.

string
enum

Two-letter ISO country code for which the tax is applied

⚠️

When country, subdivision, and postal code fields are left empty, and the remaining parameters are included and valid, the default tax rule is applied.

string
⚠️

Subdivision is null by default. The granularity of the tax_rate is derived from the most granular breakdown available based on the following hierarchy: country | subdivision | postal code.
For some countries, there can be an additional state/subdivision. This is handled according to ISO 3166-2 subdivision codes. This must include the country code and subdivision code.

string

String of numbers and letters that represents a group of people in a geographic area

⚠️

Postal_code is null by default. The granularity of the tax_rate is derived from the most granular breakdown available based on the following hierarchy: country | subdivision | postal code.

integer
enum
Defaults to 0

The deduction_order is an enum that can be set to one of 0, 1, or 2.

  • 0 - Store commission is deducted first from the gross revenue and tax is deducted from the remaining amount.
  • 1 - Tax is deducted first from the gross revenue and store commission is deducted remaining amount.
  • 2 - Both tax and store commission are deducted from the total revenue.
Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json