Skip to main content
POST
Calculate Product Taxes

Authorizations

x-api-key
string
header
required

Merchant API Key

x-signature
string
header
required

Generated request signature

Body

application/json
mode
enum<string>
required

Required. SESSION or SUBSCRIPTION. Decides which discount object is allowed.

Available options:
SESSION,
SUBSCRIPTION
quoteCurrCode
string
required

Required*. Currency of the amount values. Filled automatically if the merchant has only one allowed quote currency.

billTo
object
required

Required*. Billing address. Decides the tax rules and the legal entity. Filled automatically if the merchant has only one mapped country (other than GLOBAL).

items
object[]
required

Required. List of items. At least one item.

postalCode
string

Optional. Overrides billTo.postalCode.

userTaxId
string

Optional. Use a specific tax registration for the calculation.

gstInclusive
boolean

Optional. true if amount already includes tax. Defaults to the merchant's setting.

discount
object

Optional, SESSION only. Discount for a billing session.

coupon
object

Optional, SUBSCRIPTION only. Coupon for a subscription.

Response

200 - application/json

calculated taxes

quoteCurrCode
string

Currency you quoted in.

quoteAmount
number

Total after discount, in quoteCurrCode.

code
string

Merchant settlement currency.

amount
number

Total converted to the settlement currency.

totalAmount
number

Final amount to pay.

quoteAmt
number

Same as quoteAmount. Kept for backward compatibility.

tax
object

Tax breakdown: rates, amount per tax component, and total tax.

gstInclusive
boolean

Whether the amounts were calculated as tax-inclusive.

discount
object

The discount or coupon that was applied, plus amountOff in the settlement currency.

items
object[]

Your items, each with inrAmount added (line total × FX rate).

billDetails
object

The final billTo address and the same items list.