Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
calcMode
enum<string>

Calculation Mode

Available options:
markup,
margin,
discount,
reverse,
stacked
costPrice
number

Cost Price

Required range: x >= 0
markupPercent
number

Markup %

Required range: x >= 0
salePrice
number

Sale Price

Required range: x >= 0
originalPrice
number

Original Price

Required range: x >= 0
discountPercent
number

Discount %

Required range: 0 <= x <= 100
finalPrice
number

Final (Discounted) Price

Required range: x >= 0
stackedDiscount1
number

Discount 1 %

Required range: 0 <= x <= 100
stackedDiscount2
number

Discount 2 %

Required range: 0 <= x <= 100
stackedDiscount3
number

Discount 3 % (optional)

Required range: 0 <= x <= 100

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.