Skip to main content
GET
Poll a quote request

Authorizations

X-API-Key
string
header
required

Your ProvenMetal API key (pm_live_...). Authorization: Bearer <key> also works.

Path Parameters

request_id
string
required
Maximum string length: 64

Query Parameters

wait_s
integer
default:0

Seconds to wait for it to finish.

Required range: 0 <= x <= 150

Response

Successful Response

ok
boolean
required
mode
enum<string>
required

instant: a live price the customer pays at checkout_url. review: ProvenMetal's team quotes it (custom options, or parts that couldn't be priced); the customer requests it at checkout_url.

Available options:
instant,
review
quote_id
string
required

64 hex characters: GET /v1/quotes/{quote_id} reports where it stands.

checkout_url
string
required
quantity
integer
required
request_id
string | null

The quote request that made it.

total
string | null

Total in USD, delivered, with tax (instant). null for review.

per_board
string | null
tax
string | null
currency
string | null

instant: USD.

total_cents
integer | null

instant: the total in cents.

per_board_cents
integer | null
tax_cents
integer | null
lines
Lines · object[] | null

instant: what the total is made of, each {label, cents}.

board_details
Board Details · object | null

instant: the board as priced (layers, width_mm, height_mm, thickness_mm, copper_oz, inner_copper_oz, surface_finish, solder_mask, material).

assembled
boolean | null
lead_time
string | null

Build time.

delivery
string | null

From payment to the door, build included.

includes
string[] | null

The total's lines, as words.

board
string | null

The board in one line.

board_image_url
string | null

A PNG of the board.

delivery_saved
boolean | null

Checkout opens with the delivery details already saved.

saved_details
boolean | null

The email in ship_to has a saved card and address: the customer can pay through /saved/code, /saved/verify and /saved/pay after saying yes.

unpriced_parts
Unpriced Parts · object[] | null

review: each part that couldn't be priced, with why and what was searched, and any similar_part to offer.

picked_parts
Picked Parts · object[] | null

staff_picks_parts: the parts ProvenMetal chose.

requested_substitutions
Requested Substitutions · object[] | null
custom_quote_reasons
string[] | null

review: why it needs ProvenMetal's team.

fabrication_quote
Fabrication Quote · object | null

review of an assembly: an instant price for the bare boards alone, with its own checkout_url.

notes
string[] | null
expires_at
string | null
next
string | null

What to do next, in words to relay.