Estimate tax on a transaction
Estimate the tax due on a transaction without recording it. Nothing is stored and the estimate is not retrievable afterwards, so send the same request again to price it again.
The estimate is computed for exactly one organization: send an Organization-Id, Connection-Id or Entity-Id selector, which a credential owning more than one organization must do.
Each line names either an externalProductId you have already created or a productCategory and productSubcategory pair, which is priced without creating a product. An externalProductId is unique only within a connection, so when the same id exists in more than one of your connections, send a Connection-Id to price against that connection's product; without one an ambiguous id returns 400. Addresses are validated as part of the estimate: an address that cannot be validated returns 400, one in a country Kintsugi does not cover returns 422, and an address-validation outage returns 503.
Tax is only due where an active registration covers the destination, so hasActiveRegistration false comes back with every amount at zero. Set simulateActiveRegistration to see what the transaction would be taxed at if you were registered there.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-07-21.
Target organization id (Organization-Id selector).
Target connection id; resolves to its organization.
Platform entity id; resolves to a connection's organization.
Optional source to disambiguate an Entity-Id.
Body
Your identifier for the transaction. Echoed on the response.
When the transaction takes place. Rates in force on this date are the ones applied.
Currency of every amount on the request, ISO 4217. An unrecognized code returns 400.
Set true to price the transaction as though you were registered in the destination jurisdiction. Use it to preview what registering would cost your buyers; leave it false to see what you owe today.
The buyer. null when you have no buyer to attribute the transaction to, in which case no customer-level exemption applies.
Addresses on the transaction. Supply at least a SHIP_TO or BILL_TO; an address that cannot be validated returns 400.
The lines to estimate tax for. At least one, and their amounts must sum to between -9999999999.99 and 9999999999.99.
Response
Organization the estimate was computed for. Send it as Organization-Id to target the same organization again.
Your identifier for the transaction, as supplied.
Date the transaction was priced against.
Currency of every amount below, ISO 4217.
Whether an active registration covers the destination jurisdiction. When false, no tax is due and every amount below is zero.
Total across all lines that tax was charged on.
Total tax due on the transaction.
Combined effective rate across the transaction, as a fraction of the taxable amount.
The addresses as validated, with the status of each.
Each line with the tax due on it.
Successful Response
The request was invalid.
Authentication failed or was missing.
The credential is not permitted for this request.
The requested resource was not found.
The request conflicts with existing state.
The request failed validation.
A service this request depends on was unavailable. Retry the request.