POST
/
tax-estimate
curl --request POST \
  --url https://rest.taxes.provider.com/api/v1/tax-estimate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "seller": {
    "address": {
      "line1": "412 63rd South Avenue",
      "city": "Baltimore",
      "state": "MD",
      "country": "US",
      "postalCode": "21230"
    }
  },
  "customer": {
    "name": "John Doe",
    "customerCode": "customer_test",
    "address": {
      "line1": "59, Starlight Avenue",
      "city": "Newark",
      "state": "NJ",
      "country": "US",
      "postalCode": "98712"
    }
  },
  "estimateDateTime": "2022-11-01T05:12:08.131Z",
  "currency": "USD",
  "lineItems": [
    {
      "number": 1,
      "itemCode": "cbWatch",
      "description": "A winding watch.",
      "quantity": 1,
      "amount": 100,
      "isTaxInclusive": false,
      "taxIdentifiers": [
        {
          "id": "taxCode",
          "value": "PT12312"
        }
      ]
    }
  ]
}'
{
  "seller": {
    "address": {
      "line1": "412 63rd South Avenue",
      "city": "Baltimore",
      "state": "MD",
      "country": "US",
      "postalCode": "21230"
    },
    "hasNexus": true
  },
  "customer": {
    "customerCode": "customer_test",
    "address": {
      "line1": "59, Starlight Avenue",
      "city": "Newark",
      "state": "NJ",
      "country": "US",
      "postalCode": "98712"
    }
  },
  "estimateDateTime": "2022-11-01T05:12:08.131Z",
  "currency": "USD",
  "discountAmount": 0,
  "subtotal": 100,
  "exemptAmount": 0,
  "taxableAmount": 100,
  "taxAmount": 15,
  "total": 115,
  "lineItems": [
    {
      "number": 1,
      "itemCode": "cbWatch",
      "description": "A winding watch.",
      "quantity": 1,
      "amount": 100,
      "isTaxInclusive": false,
      "isTaxable": true,
      "taxIdentifiers": [
        {
          "id": "taxCode",
          "value": "PT12312"
        }
      ],
      "discountAmount": 0,
      "subtotal": 100,
      "exemptAmount": 0,
      "taxableAmount": 100,
      "taxAmount": 15,
      "total": 115,
      "taxes": [
        {
          "number": 1,
          "jurisdiction": {
            "code": "48",
            "type": "STATE",
            "name": "CALIFORNIA"
          },
          "name": "SALE",
          "rate": 5,
          "taxableAmount": 100,
          "taxAmount": 5
        },
        {
          "number": 2,
          "jurisdiction": {
            "code": "27000",
            "type": "CITY",
            "name": "SAN FRANCISCO"
          },
          "name": "SALE",
          "rate": 10,
          "taxableAmount": 100,
          "taxAmount": 10
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The json of all the parameters specified in authentication configuration of tax app will be sent by Chargebee.

Headers

​
merchant_id
string

Merchant's domain name will be sent by Chargebee

​
trace_id
string

Unique id of the request will be sent by Chargebee

Body

application/json

Defines the parameters of a tax estimation request. This is sent to the Tax Service Adapter by Chargebee to estimate taxes for one or more line items.

​
seller
object
required

The details of the seller involved in the transaction including company code and address.

Example:
{
  "address": {
    "country": "country",
    "city": "city",
    "postalCode": "postalCode",
    "state": "state",
    "line3": "line3",
    "line2": "line2",
    "line1": "line1"
  },
  "taxRegistrationNumber": "taxRegistrationNumber",
  "hasNexus": true
}
​
customer
object
required

The details of the Customer.

Example:
{
  "address": {
    "country": "country",
    "city": "city",
    "postalCode": "postalCode",
    "state": "state",
    "line3": "line3",
    "line2": "line2",
    "line1": "line1"
  },
  "name": "name",
  "customerCode": "customerCode",
  "company": "company",
  "taxRegistrationNumber": "taxRegistrationNumber",
  "hasNexus": true,
  "locationEvidence": {
    "paymentCountryCode": "paymentCountryCode",
    "bin": "bin",
    "ip": "ip"
  },
  "taxIdentifiers": [
    { "id": "id", "value": "value" },
    { "id": "id", "value": "value" },
    { "id": "id", "value": "value" },
    { "id": "id", "value": "value" },
    { "id": "id", "value": "value" }
  ]
}
​
estimateDateTime
string<date-time>
required

The time as of which the tax estimation is to be calculated. This can be a value in the past. For example, if the value is provided as 2022-10-28T15:36:28.129+05:30, then the tax rates applicable on October 28, 2022, at 15:36:28.129, with an offset of +05:30 ahead of UTC/GMT are used for calculations. In case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC

​
currency
string
required

The currency in the ISO-4217 format.

Required string length: 3
​
lineItems
object[]
required

Contains the details of each line item in the tax estimation request.

Required array length: 1 - 1250 elements

Response

Tax estimated successfully for given line items.

The response sent by the Tax Service Adapter to Chargebee for a tax estimation request.

​
seller
object
required

The details of the seller involved in the transaction including company code and address.

Example:
{
  "address": {
    "country": "country",
    "city": "city",
    "postalCode": "postalCode",
    "state": "state",
    "line3": "line3",
    "line2": "line2",
    "line1": "line1"
  },
  "taxRegistrationNumber": "taxRegistrationNumber",
  "hasNexus": true
}
​
customer
object
required

The details of the Customer.

Example:
{
  "address": {
    "country": "country",
    "city": "city",
    "postalCode": "postalCode",
    "state": "state",
    "line3": "line3",
    "line2": "line2",
    "line1": "line1"
  },
  "name": "name",
  "customerCode": "customerCode",
  "company": "company",
  "taxRegistrationNumber": "taxRegistrationNumber",
  "hasNexus": true,
  "locationEvidence": {
    "paymentCountryCode": "paymentCountryCode",
    "bin": "bin",
    "ip": "ip"
  },
  "taxIdentifiers": [
    { "id": "id", "value": "value" },
    { "id": "id", "value": "value" },
    { "id": "id", "value": "value" },
    { "id": "id", "value": "value" },
    { "id": "id", "value": "value" }
  ]
}
​
estimateDateTime
string<date-time>
required

The time as of which the tax estimation is to be calculated. This can be a value in the past. For example, if the value is provided as 2022-10-28T15:36:28.129+05:30, then the tax rates applicable on October 28, 2022, at 15:36:28.129, with an offset of +05:30 ahead of UTC/GMT are used for calculations. In case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC

​
currency
string
required

The currency in the ISO-4217 format.

Required string length: 3
​
subtotal
number
required

The amount after discounts. This is the sum of all lineItems.subtotal.

​
exemptAmount
number
required

The part of the subtotal that is exempted from tax.

​
discountAmount
number
required

The total discount applied. This is the sum of all lineItems.discount.

​
taxableAmount
number
required

The part of the subtotal that is taxable.

​
taxAmount
number
required

The total tax payable. This is the sum of all lineItems.taxAmount.

​
total
number
required

The total after discounts and taxes. This is the same as subtotal if it is tax inclusive; otherwise it is subtotal + taxAmount. total can also be expressed as exemptAmount + taxableAmount + taxAmount.

​
lineItems
object[]
required

List of line item details for the tax estimation response.

Required array length: 1 - 1250 elements