Get a filtered list of taxes or the entire tax catalog if no filters are provided

get

https://hq1.appsflyer.com/api/net-revenue/v2.0/tax_rates/app/{app_id}

Obtain tax catalog data for all available taxes or apply filters to narrow down the search based on specific tax attributes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

app_id

string

required

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

Query Params

format

string

enum

Defaults to json

The output format of the tax catalog data. Defaults to 'json'.

Allowed:

tax_name

string

Filter catalog by the name appearing in the customer invoice that describes the specific type of tax, such as sales, VAT, GST.

tax_rate

double

0 to 100

^\d+(.\d{1,4})?$

Filter catalog by the percentage rate of the tax, specified up to 4 decimal places.

country

string

enum

Filter catalog by the two-letter ISO country code where the tax is applied.

subdivision

string

Filter catalog by the ISO 3166-2 subdivision code within the specified country.

postal_code

string

Filter catalog by postal code to identify area-specific tax rates.

tax_exclusive

boolean

Filter by whether the tax is exclusive of the price. 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.

deduction_order

integer

enum

Filter catalog by the order deductions are applied against gross revenue. 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 from the remaining amount. - 2: Both tax and store commission are deducted from the total revenue.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Integration returned

401Missing authorization token

404Token unauthorized

405Method not allowed

429Rate limit exceeded

500Internal server error