v1

latestOpenAPI 3.0.1MIT2026-07-26286592.7 KB

Platform Calculation

Calculate taxes for marketplace/platform transactions where a merchant is involved. Important: In this endpoint, amount is per-unit. The taxable base is calculated as amount × quantity.

post/tax/platform/calculations

Headers

X-API-Version'2026-01-01' required

API version. Must be 2026-01-01 for platform calculations.

Request body

rolesstring[] required

Your role(s) in this transaction

Example request

{
  "customer": {
    "tax_ids": [
      {
        "type": "us_ein",
        "value": "12-3456789"
      }
    ],
    "address": {
      "address_line_1": "3990 N County Rd 300 E",
      "address_line_2": "Unit 2",
      "address_city": "Danville",
      "address_province": "IN",
      "address_postal_code": "46122",
      "address_country": "US"
    }
  },
  "merchant": {
    "merchant_id": "my-seller-123",
    "tax_ids": [
      {
        "type": "us_ein",
        "value": "12-3456789"
      }
    ]
  },
  "order_details": {
    "customer_currency_code": "USD",
    "line_items": [
      {
        "product_category": "GENERAL_MERCHANDISE",
        "amount": 2500,
        "quantity": 3
      }
    ]
  },
  "roles": [
    "marketplace_provider"
  ],
  "fee_details": {
    "customer_currency_code": "USD",
    "line_items": [
      {
        "product_category": "GENERAL_MERCHANDISE",
        "amount": 2500,
        "quantity": 3
      }
    ]
  }
}

Response

Platform calculation response

idstring
objectstring
testmodeboolean
customer_currency_codestring
rolesstring[]
expires_atnumber

Example response

{
  "id": "calc_platform_123456789",
  "object": "tax.calculation"
}