Get Tax Rate (Sandbox)
Retrieve a simulated tax rate breakdown using specific test values in the sandbox environment.
Use this endpoint in the Sandbox environment to simulate tax rate scenarios for different countries, product types, and customer classifications. This helps validate integration logic and test edge cases before moving to production.
Tax Rate Simulation
The Sandbox environment supports specific input values to simulate deterministic behavior. You can use these values in your requests to test various scenarios.
Request Paramters
The request body accepts the following fields:
Request Paramters
Request Paramters
product_id
(string, optional) – Reference to a specific product (if known).product_category
(string, optional) – Category of the product. Examples:CSS
– Custom SoftwareDTSP
– Dev & Tech Support Services (with product)DAW
– Digital Audio Works (e.g., music tracks, podcasts)DAVW
– Digital Audio-Visual Works (e.g., multimedia videos)DB
– Digital BooksDP
– Digital PhotographsIAAS
– Infrastructure-as-a-ServicePAAS
– Platform-as-a-ServiceSAAS
– Software-as-a-Service (CRM, HRM, etc.)PRSFT
– Prewritten Software (e.g., antivirus)RNGT
– RingtonesDSWS
– Data & Web Hosting ServicesGMO
– Gaming ServicesSSS
– Streaming ServicesDTSS
– Dev & Tech Support Services (separate)INGMO
– In-Game Purchases
is_security
(boolean, optional) – Whether the product qualifies as a financial/security-type good.delivery_method
(string, required) – Method of product delivery. One of:CLOUD
– Delivered via cloud servicesPHYSICAL
– Physically transferred (e.g., hardware, CDs)DOWN
– Electronically transferred/downloaded
customer_id
(string, optional) – Unique identifier for a customer (overridescustomer_type
).customer_type
(string, optional) – Type of customer. One of:B2C
– Business to ConsumerB2B
– Business to BusinessPRISCH
– Private SchoolPRIEDUI
– Private Educational Institution (Non-School)GOV
– Government EntityPUBSCH
– Public SchoolPUBEDU
– Public Educational Institution (Non-School)PRIHOS
– Private HospitalPUBHOS
– Public HospitalNGO
– Non-Governmental Organization
location
: (object, required)
Provide customer jurisdictional context using any of:country
(string) – ISO country codestate
(string) – State or provincecounty
(string) – County or districtpostal_code
(string) – ZIP or postal codeip_address
(string) – Used for fallback geolocation
Response Fields
Returns tax determination and detailed rates:
Response Fields
Response Fields
taxable
(boolean) – Whether the product is taxable in this scenario.country_rate
(integer) – Country-level tax rate (in basis points, e.g.,18000
= 18%).state_rate
(integer) – State-level tax rate.county_rate
(integer) – County-level tax rate.special_rate
(integer) – Any special jurisdiction-specific rate.additional_rate
(integer) – Supplementary rate applied.total_rate
(integer) – Total computed effective tax rate.reverse_charge_applicable
(boolean) – Whether reverse charge mechanism applies.exempt
(boolean) – Whether the transaction is exempt from tax.
Notes
18000
= 18%.product_id
and product_category
are provided, product_id
takes priority.customer_id
and customer_type
are provided, customer_id
takes priority.Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Optional. Unique key to ensure idempotent operations (e.g., retry-safe requests).
Body
Response
Successful tax rate breakdown
The response is of type object
.