Edit net revenue measurements using the Tax API

Premium
For:
Last update:

About Net revenue and tax measurements

Net revenue is a business logic layer built to serve the AppsFlyer ROI360 in-app purchase and subscription revenue solution. It automatically calculates the net revenue value for each incoming transaction in real time and includes it in reports. 

Tax is reported by default for any transaction measured by ROI360 using the default tax rate configuration. 

The configuration can be edited using the dedicated tax API.

Learn more about Net revenue

Edit tax rates using the Tax API 

Before you begin: You must complete steps 1-2 of the ROI360 in-app purchase and subscription revenue measurement setup.

To edit the tax configuration using the tax API:

  1. Give your developer:
    • The API V2 token to use as the authorization key.
    • The parameters and values that contain information on what taxes to calculate, as outlined in the table that follows. 
  2. Tell your developer to follow their tax API instructions to create tax rate rules. Note: The API allows for a JSON file in the body of the post request. This JSON file includes all supported countries and their default tax rates. The developer can edit it or use it as is in the API.

Parameters and values to use in the API

Parameter Mandatory Remarks Record the value (for your developer to use)
tax_name Yes
  • Name appearing in the customer invoice that describes the specific type of tax. 
  • Example: Sales, VAT, GST
  
tax_rate Yes
  • Value must be greater than 0.
  • Number up to 4 decimal places representing the tax percentage to be collected.
  • Example: 7.25
  
tax_exclusive No
  • 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.
  • Default is false.
  
country No  
subdivision No
  • For some countries, there can be an additional state/subdivision.
  • Handled according to ISO 3166-2 subdivision codes.
  • Must include the country code and subdivision code.
  • Example: US-CA
  
postal_code No
  • String of letters and/or numbers
  • Example: L4J8E3
  
deduction_order No
  • Enum, either 0, 1, or 2:
    • 0 means store commission is deducted first from the gross revenue and tax is deducted from the remaining amount.
    • 1 means tax is deducted first from the gross revenue and store commission is deducted remaining amount.
    • 2 means that both tax and store commission are deducted from the total revenue.