Skip to main content
POST
Quoting is free. It tells you the exact Characters charge, whether the account can afford it, and how long the quote stays valid.
string
required
API key for authentication.

Path

string
required
The project identifier.

Body

number
required
The arrangement version to price.

Response

string
Identifier to pass to the generation endpoint.
string
Project identifier.
number
Priced arrangement version.
string
The plan the rate came from.
number
Characters per minute applied.
string
Version label of the applied rate.
number
Priced duration.
string
The price, as a JSON string. ceil(durationSec × ratePerMinute / 60).
string
When the quote stops being valid. The time to live is quoteTtlSeconds (normally 600).
boolean
Whether the balance covers the quote.
string
How much is missing; "0" when affordable.
string
Projected balance after the charge.
object
{ monthly, additional, total }, each a string.
Every Characters value is a JSON string, because 64-bit integers are serialized as strings to preserve precision. Convert to an integer before comparing or subtracting — never compare them as strings.

Common errors

  • code = 47001: arrangementVersion is missing or invalid.
  • code = 47009: the project does not exist or is not owned by your account.
  • code = 47003 / 47004: entitlement is still syncing or undecided; retry shortly.