Retrieve a simulated tax rate breakdown using specific test values in the sandbox environment.
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 Purchasesis_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/downloadedcustomer_id
(string, optional) – Unique identifier for a customer (overrides customer_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 Organizationlocation
: (object, required)country
(string) – ISO country codestate
(string) – State or provincecounty
(string) – County or districtpostal_code
(string) – ZIP or postal codeip_address
(string) – Used for fallback geolocationResponse 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.18000
= 18%.product_id
and product_category
are provided, product_id
takes priority.customer_id
and customer_type
are provided, customer_id
takes priority.Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Optional. Unique key to ensure idempotent operations (e.g., retry-safe requests).
Successful tax rate breakdown
The response is of type object
.