Calculate Tax for a Transaction

Overview

The Tax Estimation API calculates the estimated tax for a transaction based on your organization’s nexus status, product taxability, customer exemptions, and shipping addresses. This endpoint is idempotent and doesn’t create permanent transaction records, making it perfect for testing tax calculations during checkout flows.

When to Use

Shopping cart pages: Calculate tax when customers review their order
Checkout flows: After address entry but before payment processing
Subscription billing: Calculate tax for recurring charges
Quote generation: Provide tax estimates to customers

Authentication

This endpoint requires two headers:

x-api-key: Your API key
x-organization-id: Your organization ID

Both headers are required for authentication. You can find your API key and organization ID in your Kintsugi dashboard.

Try It Out

Use the interactive playground below to test the tax estimation endpoint. The playground will automatically include the required authentication headers.

The playground prefills example values from the API schema. Modify the request body to test different scenarios like different addresses, product types, or customer exemptions.

Common Use Cases

Basic Tax Calculation

Calculate tax for a simple transaction with a shipping address:

{
  "date": "2024-01-15T10:00:00Z",
  "external_id": "order-123",
  "currency": "USD",
  "source": "API",
  "transaction_items": [
    {
      "external_id": "item-1",
      "external_product_id": "product-123",
      "product_name": "Example Product",
      "quantity": "1.0",
      "amount": 100.00
    }
  ],
  "addresses": [
    {
      "type": "SHIP_TO",
      "street_1": "123 Main St",
      "city": "Seattle",
      "state": "WA",
      "postal_code": "98101",
      "country": "US"
    }
  ]
}

With Customer Information

Include customer details to check for exemptions:

{
  "date": "2024-01-15T10:00:00Z",
  "external_id": "order-123",
  "currency": "USD",
  "source": "API",
  "customer": {
    "name": "John Doe",
    "email": "[email protected]",
    "street_1": "123 Main St",
    "city": "Seattle",
    "state": "WA",
    "postal_code": "98101",
    "country": "US"
  },
  "transaction_items": [
    {
      "external_id": "item-1",
      "external_product_id": "product-123",
      "product_name": "Example Product",
      "quantity": "1.0",
      "amount": 100.00
    }
  ],
  "addresses": [
    {
      "type": "SHIP_TO",
      "street_1": "123 Main St",
      "city": "Seattle",
      "state": "WA",
      "postal_code": "98101",
      "country": "US"
    }
  ]
}

Response Fields

The API returns detailed tax information:

total_tax_amount_calculated: Total tax amount for the transaction
taxable_amount: Amount subject to tax
tax_rate_calculated: Overall tax rate
nexus_met: Whether your organization has nexus in the destination jurisdiction
has_active_registration: Whether you have an active registration
transaction_items: Array with tax details for each item

Next Steps

Create a Transaction - Record the transaction after payment
Sales Tax Calculations Guide - Learn more about tax calculation
Getting Started - Set up your integration

Authorizations

X-API-KEY

string

header

required

x-organization-id

string

header

required

Query Parameters

simulate_nexus_met

boolean

deprecated

Deprecated: Use simulate_active_registration in the request body instead.

Body

application/json

Public request model for tax estimation API documentation. This model excludes internal fields like enriched_fields and total_amount that should not be exposed in API docs.

date

string<date-time>

required

The date of the transaction in ISO 8601 format (e.g., 2025-01-25T12:00:00Z).

external_id

string

required

Unique identifier of this transaction in the source system.

currency

enum<string>

required

The currency in which the transaction is conducted (e.g., USD, EUR).

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GGP,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

IMP,

INR,

IQD,

IRR,

ISK,

JEP,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SPL,

SRD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TVD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

XAF,

XCD,

XDR,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWD

transaction_items

TransactionItemEstimateBase · object[]

required

List of items involved in the transaction.

Show child attributes

transaction_items.date

string<date-time>

required

The date of the transaction item.

transaction_items.amount

number

required

The total amount of the item.

transaction_items.external_id

string

A unique identifier for the transaction item.

transaction_items.description

string

A description of the item.

transaction_items.external_product_id

string

External product identifier. If not found and product_subcategory and product_category are not provided, an error occurs.

transaction_items.product_name

string

Name of the product. Used if creating a new product.

transaction_items.product_description

string

Description of the product. Used if creating a new product.

transaction_items.product_source

enum<string>

Available options:

BIGCOMMERCE,

BESTBUY,

BUNNY,

CHARGEBEE,

SHOPIFY,

STRIPE,

AMAZON,

TIKTOK,

CUSTOM,

UNKNOWN,

IMPORT,

ZUORA,

APIDECK,

QUICKBOOKS,

API,

APPLE_APP_STORE,

GOOGLE_APP_STORE,

WALMART,

PAYPAL,

NETSUITE,

XERO,

MAXIO,

RECURLY,

SALESFORCE,

ETSY,

EBAY,

WIX,

SQUARESPACE,

WOOCOMMERCE,

MAGENTO,

BILLING_PLATFORM,

DEEL,

RIPPLING,

GUSTO,

FACEBOOK,

OTHER,

ORDWAY,

INSTAGRAM,

PINTEREST,

WAYFAIR,

WISH,

POS,

TARGET,

NEWEGG,

GROUPON,

GOOGLE_EXPRESS,

NOCNOC,

MERCADO_LIBRE,

MODALYST,

NORDSTROM,

FAIRE,

SHOPWARE,

ZOHO,

SAGE-INTACCT,

AIRWALLEX,

ORB,

ZENSKAR

transaction_items.product_subcategory

string

Subcategory of the product. Required if product_category is used in place of external_product_id.

transaction_items.product_category

string

Category of the product. Required if product_subcategory is used in place of external_product_id.

transaction_items.quantity

number

default:1.0

Defaults to 1.0. The quantity of the item.

transaction_items.exempt

boolean

default:false

Defaults to false. Indicates whether the item is exempt from tax.

addresses

The address information for this transaction. · object[]

required

Show child attributes

addresses.type

enum<string>

required

Type of the address. Must be either SHIP_TO or BILL_TO.

Available options:

SHIP_TO,

BILL_TO

addresses.state

string

required

State or province of the address.

addresses.postal_code

string

required

Postal code of the address.

addresses.country

string

required

Country of the address.

addresses.phone

string

Phone number associated with the customer.

addresses.street_1

string

Primary street address of the customer.

addresses.street_2

string

Additional street address details, such as an apartment or suite number.

addresses.city

string

City where the customer resides.

addresses.county

string

County or district of the customer.

addresses.full_address

string

Complete address string of the customer, which can be used as an alternative to individual fields.

addresses.status

string

deprecated

Status of the address. Deprecated and ignored.

description

string

An optional description of the transaction.

source

enum<string>

deprecated

While currently not used, it may be used in the future to determine taxability. The source of the transaction (e.g., OTHER).

Available options:

BIGCOMMERCE,

BESTBUY,

BUNNY,

CHARGEBEE,

SHOPIFY,

STRIPE,

AMAZON,

TIKTOK,

CUSTOM,

UNKNOWN,

IMPORT,

ZUORA,

APIDECK,

QUICKBOOKS,

API,

APPLE_APP_STORE,

GOOGLE_APP_STORE,

WALMART,

PAYPAL,

NETSUITE,

XERO,

MAXIO,

RECURLY,

SALESFORCE,

ETSY,

EBAY,

WIX,

SQUARESPACE,

WOOCOMMERCE,

MAGENTO,

BILLING_PLATFORM,

DEEL,

RIPPLING,

GUSTO,

FACEBOOK,

OTHER,

ORDWAY,

INSTAGRAM,

PINTEREST,

WAYFAIR,

WISH,

POS,

TARGET,

NEWEGG,

GROUPON,

GOOGLE_EXPRESS,

NOCNOC,

MERCADO_LIBRE,

MODALYST,

NORDSTROM,

FAIRE,

SHOPWARE,

ZOHO,

SAGE-INTACCT,

AIRWALLEX,

ORB,

ZENSKAR

marketplace

boolean

default:false

Indicates if the transaction involves a marketplace.

customer

The customer who placed the transaction. · object

Details about the customer. If the customer is not found, it will be ignored.

Show child attributes

customer.phone

string

Phone number associated with the address.

customer.street_1

string

Primary street address.

customer.street_2

string

Additional street address details, such as an apartment or suite number.

customer.city

string

City where the customer resides.

customer.county

string

County or district of the customer.

customer.state

string

State or province of the customer.

customer.postal_code

string

ZIP or Postal code of the customer.

customer.country

enum<string>

Country code in ISO 3166-1 alpha-2 format

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

CV,

KH,

CM,

CA,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

SZ,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

CI,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MK,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

XK,

ZZ_EU

customer.full_address

string

Complete address string of the customer, which can be used as an alternative to individual fields.

customer.name

string

Name of the customer.

customer.external_id

string

A unique identifier for the customer.

customer.status

enum<string>

default:ACTIVE

Status of the customer (e.g., ACTIVE, INACTIVE).

Available options:

ACTIVE,

ARCHIVED

customer.email

string

Email address of the customer.

customer.address_status

enum<string>

default:UNVERIFIED

Address status of the customer. Defaults to UNVERIFIED.

Available options:

UNVERIFIED,

INVALID,

PARTIALLY_VERIFIED,

VERIFIED,

UNVERIFIABLE,

BLANK

customer.source

enum<string>

Source of the customer information (e.g., BIGCOMMERCE, STRIPE, etc.).

Available options:

BIGCOMMERCE,

BESTBUY,

BUNNY,

CHARGEBEE,

SHOPIFY,

STRIPE,

AMAZON,

TIKTOK,

CUSTOM,

UNKNOWN,

IMPORT,

ZUORA,

APIDECK,

QUICKBOOKS,

API,

APPLE_APP_STORE,

GOOGLE_APP_STORE,

WALMART,

PAYPAL,

NETSUITE,

XERO,

MAXIO,

RECURLY,

SALESFORCE,

ETSY,

EBAY,

WIX,

SQUARESPACE,

WOOCOMMERCE,

MAGENTO,

BILLING_PLATFORM,

DEEL,

RIPPLING,

GUSTO,

FACEBOOK,

OTHER,

ORDWAY,

INSTAGRAM,

PINTEREST,

WAYFAIR,

WISH,

POS,

TARGET,

NEWEGG,

GROUPON,

GOOGLE_EXPRESS,

NOCNOC,

MERCADO_LIBRE,

MODALYST,

NORDSTROM,

FAIRE,

SHOPWARE,

ZOHO,

SAGE-INTACCT,

AIRWALLEX,

ORB,

ZENSKAR

customer.registration_number

string

customer.connection_id

string

Unique identifier of the connection related to the customer.

Response

Successfully retrieved data

items

TransactionEstimateResponse · object[]

required

Show child attributes

items.date

string<date-time>

required

The date of the transaction in ISO 8601 format (e.g., 2025-01-25T12:00:00Z).

items.external_id

string

required

Unique identifier of this transaction in the source system.

items.currency

enum<string>

required

The currency in which the transaction is conducted (e.g., USD, EUR).

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GGP,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

IMP,

INR,

IQD,

IRR,

ISK,

JEP,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SPL,

SRD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TVD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

XAF,

XCD,

XDR,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWD

items.transaction_items

TransactionItemEstimateResponse · object[]

required

Show child attributes

items.transaction_items.date

string<date-time>

required

The date of the transaction item.

items.transaction_items.amount

string

required

The total amount of the item.

items.transaction_items.external_id

string

A unique identifier for the transaction item.

items.transaction_items.description

string

A description of the item.

items.transaction_items.external_product_id

string

External product identifier. If not found and product_subcategory and product_category are not provided, an error occurs.

items.transaction_items.product_name

string

Name of the product. Used if creating a new product.

items.transaction_items.product_description

string

Description of the product. Used if creating a new product.

items.transaction_items.product_source

enum<string>

Available options:

BIGCOMMERCE,

BESTBUY,

BUNNY,

CHARGEBEE,

SHOPIFY,

STRIPE,

AMAZON,

TIKTOK,

CUSTOM,

UNKNOWN,

IMPORT,

ZUORA,

APIDECK,

QUICKBOOKS,

API,

APPLE_APP_STORE,

GOOGLE_APP_STORE,

WALMART,

PAYPAL,

NETSUITE,

XERO,

MAXIO,

RECURLY,

SALESFORCE,

ETSY,

EBAY,

WIX,

SQUARESPACE,

WOOCOMMERCE,

MAGENTO,

BILLING_PLATFORM,

DEEL,

RIPPLING,

GUSTO,

FACEBOOK,

OTHER,

ORDWAY,

INSTAGRAM,

PINTEREST,

WAYFAIR,

WISH,

POS,

TARGET,

NEWEGG,

GROUPON,

GOOGLE_EXPRESS,

NOCNOC,

MERCADO_LIBRE,

MODALYST,

NORDSTROM,

FAIRE,

SHOPWARE,

ZOHO,

SAGE-INTACCT,

AIRWALLEX,

ORB,

ZENSKAR

items.transaction_items.product_subcategory

string

Subcategory of the product. Required if product_category is used in place of external_product_id.

items.transaction_items.product_category

string

Category of the product. Required if product_subcategory is used in place of external_product_id.

items.transaction_items.quantity

string

default:1.0

Defaults to 1.0. The quantity of the item.

items.transaction_items.exempt

boolean

default:false

Indicates whether the transaction item is exempt from tax.

items.transaction_items.tax_amount

string

default:0.00

The total tax amount for the transaction item.

items.transaction_items.taxable_amount

string

default:0.00

The taxable amount for the transaction item.

items.transaction_items.tax_rate

string

default:0.00

The tax rate applied to the transaction item.

items.transaction_items.exempt_reason

enum<string>

Reason for exemption, if applicable.

Available options:

PRODUCT,

TRANSACTION,

CUSTOMER,

REGION,

REVERSE_CHARGE,

ZERO_RATE_TAX,

HIGH_VALUE_PHYSICAL_GOODS,

EXPORT,

ZERO_VALUE_ITEM,

NO_RULE_FOUND,

IMPORTED

items.transaction_items.tax_items

TaxItemEstimate · object[]

List of tax items applied to the transaction item.

Show child attributes

items.transaction_items.tax_items.name

string

required

items.transaction_items.tax_items.rate

string

default:0.0

items.transaction_items.tax_items.amount

string

default:0.0

items.transaction_items.tax_items.exempt

boolean

default:false

items.transaction_items.tax_items.exempt_reason

enum<string>

We use this to understand the response from get_tax_items

Available options:

NO_RULE_FOUND,

RULE_FOUND_TAXABLE,

RULE_FOUND_NOT_TAXABLE,

PRODUCT_EXEMPT,

FROM_IMPORT

items.transaction_items.tax_items.rule

string

items.addresses

The address information for this transaction. · object[]

required

List of addresses related to the transaction. At least one BILL_TO or SHIP_TO address must be provided. The address will be validated during estimation, and the transaction may be rejected if the address does not pass validation. The SHIP_TO will be preferred to use for determining tax liability. Deprecated: Use of address.status in estimate api is ignored and will be removed in the future status will be considered UNVERIFIED by default and always validated

Show child attributes

items.addresses.type

enum<string>

required

Type of the address. Must be either SHIP_TO or BILL_TO.

Available options:

SHIP_TO,

BILL_TO

items.addresses.state

string

required

State or province of the address.

items.addresses.postal_code

string

required

Postal code of the address.

items.addresses.country

string

required

Country of the address.

items.addresses.phone

string

Phone number associated with the customer.

items.addresses.street_1

string

Primary street address of the customer.

items.addresses.street_2

string

Additional street address details, such as an apartment or suite number.

items.addresses.city

string

City where the customer resides.

items.addresses.county

string

County or district of the customer.

items.addresses.full_address

string

Complete address string of the customer, which can be used as an alternative to individual fields.

items.addresses.status

string

deprecated

Status of the address. Deprecated and ignored.

items.addresses.enriched_fields

string

Additional enriched fields related to the address.

items.description

string

An optional description of the transaction.

items.source

enum<string>

deprecated

While currently not used, it may be used in the future to determine taxability. The source of the transaction (e.g., OTHER).

Available options:

BIGCOMMERCE,

BESTBUY,

BUNNY,

CHARGEBEE,

SHOPIFY,

STRIPE,

AMAZON,

TIKTOK,

CUSTOM,

UNKNOWN,

IMPORT,

ZUORA,

APIDECK,

QUICKBOOKS,

API,

APPLE_APP_STORE,

GOOGLE_APP_STORE,

WALMART,

PAYPAL,

NETSUITE,

XERO,

MAXIO,

RECURLY,

SALESFORCE,

ETSY,

EBAY,

WIX,

SQUARESPACE,

WOOCOMMERCE,

MAGENTO,

BILLING_PLATFORM,

DEEL,

RIPPLING,

GUSTO,

FACEBOOK,

OTHER,

ORDWAY,

INSTAGRAM,

PINTEREST,

WAYFAIR,

WISH,

POS,

TARGET,

NEWEGG,

GROUPON,

GOOGLE_EXPRESS,

NOCNOC,

MERCADO_LIBRE,

MODALYST,

NORDSTROM,

FAIRE,

SHOPWARE,

ZOHO,

SAGE-INTACCT,

AIRWALLEX,

ORB,

ZENSKAR

items.marketplace

boolean

default:false

Indicates if the transaction involves a marketplace.

items.customer

The customer who placed the transaction. · object

Details about the customer. If the customer is not found, it will be ignored.

Show child attributes

items.customer.phone

string

Phone number associated with the address.

items.customer.street_1

string

Primary street address.

items.customer.street_2

string

Additional street address details, such as an apartment or suite number.

items.customer.city

string

City where the customer resides.

items.customer.county

string

County or district of the customer.

items.customer.state

string

State or province of the customer.

items.customer.postal_code

string

ZIP or Postal code of the customer.

items.customer.country

enum<string>

Country code in ISO 3166-1 alpha-2 format

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

CV,

KH,

CM,

CA,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

SZ,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

CI,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MK,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

XK,

ZZ_EU

items.customer.full_address

string

Complete address string of the customer, which can be used as an alternative to individual fields.

items.customer.name

string

Name of the customer.

items.customer.external_id

string

A unique identifier for the customer.

items.customer.status

enum<string>

default:ACTIVE

Status of the customer (e.g., ACTIVE, INACTIVE).

Available options:

ACTIVE,

ARCHIVED

items.customer.email

string

Email address of the customer.

items.customer.address_status

enum<string>

default:UNVERIFIED

Address status of the customer. Defaults to UNVERIFIED.

Available options:

UNVERIFIED,

INVALID,

PARTIALLY_VERIFIED,

VERIFIED,

UNVERIFIABLE,

BLANK

items.customer.source

enum<string>

Source of the customer information (e.g., BIGCOMMERCE, STRIPE, etc.).

Available options:

BIGCOMMERCE,

BESTBUY,

BUNNY,

CHARGEBEE,

SHOPIFY,

STRIPE,

AMAZON,

TIKTOK,

CUSTOM,

UNKNOWN,

IMPORT,

ZUORA,

APIDECK,

QUICKBOOKS,

API,

APPLE_APP_STORE,

GOOGLE_APP_STORE,

WALMART,

PAYPAL,

NETSUITE,

XERO,

MAXIO,

RECURLY,

SALESFORCE,

ETSY,

EBAY,

WIX,

SQUARESPACE,

WOOCOMMERCE,

MAGENTO,

BILLING_PLATFORM,

DEEL,

RIPPLING,

GUSTO,

FACEBOOK,

OTHER,

ORDWAY,

INSTAGRAM,

PINTEREST,

WAYFAIR,

WISH,

POS,

TARGET,

NEWEGG,

GROUPON,

GOOGLE_EXPRESS,

NOCNOC,

MERCADO_LIBRE,

MODALYST,

NORDSTROM,

FAIRE,

SHOPWARE,

ZOHO,

SAGE-INTACCT,

AIRWALLEX,

ORB,

ZENSKAR

items.customer.registration_number

string

items.customer.connection_id

string

Unique identifier of the connection related to the customer.

items.total_tax_amount_calculated

string

default:0.00

The total amount of tax determined for the transaction.

items.taxable_amount

string

default:0.00

The taxable amount for the transaction.

items.tax_rate_calculated

string

default:0.00

The calculated tax rate for the transaction.

items.nexus_met

boolean

default:false

deprecated

Indicates if nexus was met for the transaction.Deprecated: Use has_active_registration instead.

items.has_active_registration

boolean

default:false

Indicates if there is an active registration for the transaction.

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

pages

integer

required

Required range: x >= 0

​Calculate Tax for a Transaction

​Overview

​When to Use

​Authentication

​Try It Out

​Common Use Cases

​Basic Tax Calculation

​With Customer Information

​Response Fields

​Next Steps

​Related Resources

Authorizations

Query Parameters

Body

Response

Calculate Tax for a Transaction

Overview

When to Use

Authentication

Try It Out

Common Use Cases

Basic Tax Calculation

With Customer Information

Response Fields

Next Steps

Related Resources