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
subtotal
number
required

Bill Subtotal

Required range: x >= 0.01
numPeople
number
required

Number of People

Required range: 1 <= x <= 100
taxMode
enum<string>

Tax Entry

Available options:
amount,
percent
taxAmount
number

Tax

Required range: x >= 0
taxPercent
number

Tax %

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

Discount

Required range: x >= 0
tipPreset
enum<string>

Tip Preset

Available options:
custom,
us,
ca,
uk,
au,
fr,
jp
tipPercent
number

Tip %

Required range: 0 <= x <= 100
tipBasis
enum<string>

Tip On

Available options:
subtotal,
total
currency
enum<string>

Currency

Available options:
USD,
EUR,
GBP,
AUD,
JPY,
CAD
roundUp
boolean

Round up each person's share to the next whole currency unit (for easier cash payment)

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.