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

Print Type

Available options:
bw,
color
blackCartridgePrice
number

Black Cartridge Price

Required range: x >= 0.01
blackPageYield
number

Black Cartridge Yield (pages)

Required range: x >= 1
colorCartridgePrice
number

Color Cartridge Price

Required range: x >= 0.01
colorPageYield
number

Color Cartridge Yield (pages)

Required range: x >= 1
paperPrice
number

Paper Price (per ream)

Required range: x >= 0
sheetsPerReam
number

Sheets Per Ream

Required range: x >= 1
pagesPerJob
number

Pages Per Print Job

Required range: x >= 1
pagesPerMonth
number

Pages Printed Per Month

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

Currency

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

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.