Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Products

Preview product tax

Preview estimated indirect taxes (VAT, GST, sales tax) for products before checkout.

Returns per-item details:

  • jurisdiction, taxType, taxRate, taxPercent, taxPrice, and localized display amounts.

Send requests as one or more country/currency groups:

  • U.S. groups: include zip at the group level to compute sales tax. If omitted, the response may return taxRate: 0 and taxPrice: 0. ZIP is only supported at the group level.
  • Pricing:
    • Virtual/non-catalog items: pricing.price is required.
    • Catalog items: if pricing.price (or price) is provided, it overrides the catalog price for the preview.
post/products/tax

Request body

pageinteger

Page number for paginated results.

limitinteger

Maximum number of items across all groups to include per page.

Example request

{
  "page": 1,
  "limit": 4,
  "groups": [
    {
      "country": "US",
      "currency": "USD",
      "zip": "35006",
      "items": [
        {
          "product": "virtual-coaching",
          "pricing": {
            "price": 299
          }
        }
      ]
    }
  ]
}

Response

OK

actionstring

Action identifier for the operation.

resultstring

Outcome of the operation.

pageinteger

Current page number.

limitinteger

Page size limit.

totalItemsinteger

Total number of items across all result pages.

totalPagesinteger

Total number of pages available.

priceModestring

Pricing mode used when previewing totals.

Example response

{
  "action": "product.tax.lookup",
  "result": "success",
  "page": 1,
  "limit": 4,
  "totalItems": 5,
  "totalPages": 2,
  "priceMode": "GROSS",
  "results": [
    {
      "country": "US",
      "currency": "USD",
      "zip": "35006",
      "totalGroupItems": 2,
      "items": [
        {
          "productPath": "virtual-coaching",
          "listPrice": 276.85,
          "listPriceDisplay": "$276.85",
          "tax": {
            "jurisdiction": "US",
            "taxCode": "DC020500",
            "taxType": "US_SALES_TAX",
            "taxRate": 0.08,
            "taxPercent": 8,
            "taxPrice": 22.15,
            "taxPriceDisplay": "$22.15"
          },
          "productTotal": {
            "total": 299,
            "totalDisplay": "$299.00"
          }
        }
      ]
    }
  ]
}