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
mode
enum<string>

Mode

Available options:
add,
remove
price
number

Price

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

Common Rate

Available options:
custom,
uk,
de,
fr,
nl,
es,
it,
se,
ch,
jp,
au,
ca,
in,
sg
taxRate
number

Tax Rate (%)

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.