Sign in
Plans

Calculate Tax

Previews tax for a plan before checkout, based on the buyer's location.

post/plans/{id}/calculate_tax

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

ip_addressstring

Buyer IP address used to infer location when no billing address is provided.

Example request

{
  "address": {
    "country": "DE",
    "postal_code": "10115"
  }
}

Response

tax calculated

currencystring required

Three-letter ISO 4217 currency code for the returned amounts.

status'calculated' | 'not_calculated' required

Whether Whop calculated tax for this preview. not_calculated means no tax could be determined, so tax_amount is 0 and total equals subtotal.

subtotalinteger required

Plan price in the currency's smallest unit, for example cents. For exclusive tax, this is the pre-tax amount; for inclusive tax, it already includes tax and equals the total.

tax_amountinteger required

Calculated tax amount in the currency's smallest unit. For exclusive tax, this is added on top of the subtotal; for inclusive tax, it is the portion of the subtotal that is tax.

tax_behavior'exclusive' | 'inclusive' required

Whether tax is added on top of the plan price or already included in it for this buyer's location.

totalinteger required

Amount the buyer would pay in the currency's smallest unit.

Example response

{
  "currency": "usd",
  "status": "calculated",
  "subtotal": 1000,
  "tax_amount": 70,
  "tax_behavior": "exclusive",
  "total": 1070
}

Changes

Changed in 3 of the 44 revisions of this API.6

  • ae20b30817de1See the full diff
    • ○

      added the non-success response with the status 409

      response-non-success-status-added

  • f1020c3ecda44See the full diff
    • ○

      added the optional property error/code to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property error/code to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property error/code to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property error/code to the response with the 404 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc1See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 44 revisions, 1 has no diff computed.