Simulate what-if repricing
Replays a window of your OWN observed traffic (aggregated per billable lane) against a CANDIDATE rate card and projects the cost side-by-side with what the traffic was actually billed. Submit up to 5000 usage lanes and 5000 candidate rates; traffic is held fixed and only the rate card is swapped — the “what-if”. It is a read-only cost estimate: it neither writes the candidate rate card nor initiates any send. Returns 422 for out-of-range input.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Response
The projected re-pricing in the standard { data, meta } envelope — the candidate cost per lane and in total, alongside the actual billed amount for the same traffic. Returns 422 when the simulator input is out of range.
The projected re-pricing in the standard { data, meta } envelope — the candidate cost per lane and in total, alongside the actual billed amount for the same traffic. Returns 422 when the simulator input is out of range.