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

Vehicle Price / Negotiated Cap Cost ($)

Required range: x >= 0
residualValue
number
required

Residual Value

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

Residual Value As

Available options:
percent,
amount
moneyFactor
number

Money Factor

Required range: x >= 0
leaseTerm
number

Lease Term (Months)

Required range: 12 <= x <= 60
downPayment
number

Down Payment / Cap Cost Reduction ($)

Required range: x >= 0
taxRate
number

Sales Tax Rate (%)

Required range: 0 <= x <= 15
fees
number

Fees (acquisition, doc, etc.) ($)

Required range: x >= 0

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.