Skip to content
PaxExact

Docs

PaxExact API

BETA

A REST API for creating and working estimates against PaxExact with your own organization's credentials. It never returns a price as zero: when PaxExact can't price a line, it returns a reason code instead.

In beta. Keys are issued by PaxExact staff by arrangement — this page describes the contract as built, not a self-serve developer signup.

Environments and keys

Every key is organization-scoped and prefixed by environment: pxk_live_… for production data, pxk_test_… for an isolated sandbox. A sandbox key can only see and create sandbox estimates; a live key only live ones — the two never cross.

Keys are shown once, at issuance or rotation. PaxExact stores only a SHA-256 verifier and cannot show a key's secret again.

Scopes

Scopes are explicit and least-privilege — nothing is implied by another scope.

  • pricing:read — read pricing resolution, without writing anything.
  • estimates:read — read estimates, rooms, and line items.
  • estimates:write — create and update estimates, rooms, and line items.

Rate limits

Each key is limited to a default of 120 requests per minute, configurable per key. Every authenticated response carries X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset so a client can pace itself before hitting the limit.

The estimate contract

The shape and vocabulary of an estimate — its pricing states, quantity states, and totals — is a versioned contract, currently paxexact-estimate-v1. Additive fields never change the version; breaking changes bump it.

A missing price is never returned as 0. An unpriced line reports a reason_code instead — the API is built to say what it doesn't know, not to guess.

Request tracing

Every response carries a request id — successful responses in an X-Request-ID header, error responses in the error body — so a specific call can be traced and reported.

Access

Not yet self-serve

Deployed and answering in production. Limits: keys are issued by PaxExact staff by arrangement — there is no self-serve key signup — and the scope is estimates, rooms, line items and pricing lookup, which has no production price catalog behind it yet (see source-tracked pricing). There are no webhooks, connectors or usage quotas yet.