Create Calculations

curl --request POST \
  --url https://api.numeralhq.com/tax/calculations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '
{
  "customer": {
    "type": "CONSUMER",
    "address": {
      "address_line_1": "4 Privet Drive",
      "address_city": "Little Whinging",
      "address_province": "CA",
      "address_postal_code": "90210",
      "address_country": "US",
      "address_type": "shipping"
    }
  },
  "origin_address": {
    "address_line_1": "3990 N County Rd 300 E",
    "address_city": "Danville",
    "address_province": "IN",
    "address_postal_code": "46122",
    "address_country": "US"
  },
  "order_details": {
    "customer_currency_code": "USD",
    "tax_included_in_amount": false,
    "automatic_tax": "auto",
    "line_items": [
      {
        "reference_product_id": "wand_elder_12",
        "amount": 10000,
        "quantity": 1
      }
    ]
  }
}
'

{
  "testmode": true,
  "id": "calc_1783369568468633ea55e-084a-419e-9d47-9f07aa27f571",
  "object": "tax.calculation",
  "customer_currency_code": "USD",
  "line_items": [
    {
      "line_item_id": "li_1783369568468ae179a21-411f-4a7f-a192-66a23331dc24",
      "product": {
        "reference_line_item_id": "",
        "reference_product_id": "wand_elder_12",
        "reference_product_name": "Elder Wand",
        "product_tax_code": "GENERAL_MERCHANDISE"
      },
      "tax_jurisdictions": [
        {
          "tax_rate": 0.0725,
          "rate_type": "general state sales tax",
          "jurisdiction_name": "California",
          "fee_amount": 0,
          "note": "RATE_FRAC"
        },
        {
          "tax_rate": 0.025,
          "rate_type": "general county local sales tax",
          "jurisdiction_name": "Los Angeles",
          "fee_amount": 0,
          "note": "RATE_FRAC"
        }
      ],
      "tax_amount": 975,
      "amount_excluding_tax": 10000,
      "amount_including_tax": 10975,
      "quantity": 1
    }
  ],
  "total_tax_amount": 975,
  "tax_included_in_amount": false,
  "total_amount_excluding_tax": 10000,
  "total_amount_including_tax": 10975,
  "expires_at": 1783455968,
  "customer": {
    "type": "CONSUMER"
  },
  "automatic_tax": "auto",
  "address_resolution_status": "EXACT",
  "address_used": {
    "address_line_1": "4 Privet Drive",
    "address_city": "Little Whinging",
    "address_province": "CA",
    "address_postal_code": "90210",
    "address_country": "US"
  }
}

POST

tax

calculations

curl --request POST \
  --url https://api.numeralhq.com/tax/calculations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '
{
  "customer": {
    "type": "CONSUMER",
    "address": {
      "address_line_1": "4 Privet Drive",
      "address_city": "Little Whinging",
      "address_province": "CA",
      "address_postal_code": "90210",
      "address_country": "US",
      "address_type": "shipping"
    }
  },
  "origin_address": {
    "address_line_1": "3990 N County Rd 300 E",
    "address_city": "Danville",
    "address_province": "IN",
    "address_postal_code": "46122",
    "address_country": "US"
  },
  "order_details": {
    "customer_currency_code": "USD",
    "tax_included_in_amount": false,
    "automatic_tax": "auto",
    "line_items": [
      {
        "reference_product_id": "wand_elder_12",
        "amount": 10000,
        "quantity": 1
      }
    ]
  }
}
'

{
  "testmode": true,
  "id": "calc_1783369568468633ea55e-084a-419e-9d47-9f07aa27f571",
  "object": "tax.calculation",
  "customer_currency_code": "USD",
  "line_items": [
    {
      "line_item_id": "li_1783369568468ae179a21-411f-4a7f-a192-66a23331dc24",
      "product": {
        "reference_line_item_id": "",
        "reference_product_id": "wand_elder_12",
        "reference_product_name": "Elder Wand",
        "product_tax_code": "GENERAL_MERCHANDISE"
      },
      "tax_jurisdictions": [
        {
          "tax_rate": 0.0725,
          "rate_type": "general state sales tax",
          "jurisdiction_name": "California",
          "fee_amount": 0,
          "note": "RATE_FRAC"
        },
        {
          "tax_rate": 0.025,
          "rate_type": "general county local sales tax",
          "jurisdiction_name": "Los Angeles",
          "fee_amount": 0,
          "note": "RATE_FRAC"
        }
      ],
      "tax_amount": 975,
      "amount_excluding_tax": 10000,
      "amount_including_tax": 10975,
      "quantity": 1
    }
  ],
  "total_tax_amount": 975,
  "tax_included_in_amount": false,
  "total_amount_excluding_tax": 10000,
  "total_amount_including_tax": 10975,
  "expires_at": 1783455968,
  "customer": {
    "type": "CONSUMER"
  },
  "automatic_tax": "auto",
  "address_resolution_status": "EXACT",
  "address_used": {
    "address_line_1": "4 Privet Drive",
    "address_city": "Little Whinging",
    "address_province": "CA",
    "address_postal_code": "90210",
    "address_country": "US"
  }
}

Get tax information for a given product and address

New requirements in 2025-05-12:

order_details.automatic_tax is required ("auto" or "disabled"), and must be "auto" for US addresses.
origin_address is required at calculation time unless a default origin address is configured for the destination jurisdiction on your account.

Also new in 2025-05-12: customer.type (CONSUMER/BUSINESS, default CONSUMER), customer.tax_ids (types VAT/GST/EIN; required for BUSINESS with a non-US address, rejected for CONSUMER), customer.skip_tax_id_validation, expanded currency support (126 codes) and destination countries (82). Responses add customer, automatic_tax, address_resolution_status, and address_used. Line item amount is still the total for the line — per-unit pricing starts in 2026-01-01.

cURL Header Example

Use X-API-Version explicitly in requests:

curl --request POST \
  --url https://api.numeralhq.com/tax/calculations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: 2025-05-12' \
  --data '{ ... }'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version

enum<string>

default:2025-05-12

required

The API version for this request. Always set a version: pass this header explicitly (recommended), or configure a default API version on your account and omit the header. Accounts with no configured version fall back to 2024-09-01, NOT this version.

Available options:

2025-05-12

Body

application/json

customer

object

required

Customer details. Address is required. Optionally accepts a customer ID for order tracking and exemptions.

Show child attributes

order_details

object

required

Show child attributes

origin_address

object

The address that a product is shipped from. Starting with API version 2025-05-12 this is required at calculation time unless a default origin address is configured for the destination jurisdiction on your account — omitting it with no default configured returns a 400.

Show child attributes

metadata

object

You can store arbitrary keys and values in the metadata. At most 50 keys; each key at most 255 characters; each value must be a string of at most 255 characters (non-string values are rejected).

Show child attributes

Response

Calculate response

string

The ID of the calculation. You will use this to create a transaction.

Example:

"calc_1783369568468633ea55e-084a-419e-9d47-9f07aa27f571"

object

string

The type of object: tax.calculation.

Example:

"tax.calculation"

customer_currency_code

string

The ISO-4217 currency code of the transaction.

Example:

"USD"

customer

object

Customer information returned in the response.

Show child attributes

automatic_tax

enum<string>

The automatic tax setting for this calculation.

Available options:

auto,

disabled

Example:

"auto"

line_items

object[]

Show child attributes

tax_included_in_amount

boolean

Example:

false

total_tax_amount

integer

Total tax to charge on this calculation, in the currency's smallest unit (rounded to an integer).

Example:

140

total_amount_excluding_tax

integer

Total sale charge excluding tax, in the currency's smallest unit (rounded to an integer).

Example:

2000

total_amount_including_tax

integer

Total sale charge plus tax, in the currency's smallest unit (rounded to an integer). What you should charge your customer.

Example:

2140

expires_at

integer

Unix timestamp in seconds at which the quoted tax rates expire — 24 hours after the calculation is created.

Example:

1714787673

testmode

boolean

True if using a production API key. False if using a test API key.

Example:

false

address_resolution_status

enum<string>

Status of address resolution for the customer address. EXACT: exact address match found, POSTAL_FALLBACK_1: used postal code fallback, POSTAL_ONLY: only postal code was used for tax calculation.

Available options:

EXACT,

POSTAL_FALLBACK_1,

POSTAL_ONLY

Example:

"EXACT"

address_used

object

The actual address used for tax calculation after resolution.

Show child attributes

metadata

object

You can store arbitrary keys and values in the metadata. At most 50 keys; each key at most 255 characters; each value must be a string of at most 255 characters (non-string values are rejected).

Show child attributes

⌘I

Get Started

AI help

Integration FAQs

Essentials

Objects

API Reference

cURL Header Example

Authorizations

Headers

Body

Response

​cURL Header Example

Authorizations

Headers

Body

Response

cURL Header Example