Skip to main content
GET
Estimate the cost of a message

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox 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.

Available options:
true,
false

Response

Estimate in the standard { data, meta } envelope — the resolved channel, to, countryCode, a rate object (ratePerUnit, currency, countryCode) or null when no rate is published, and when allIn=true an allIn object (baseRatePerUnit, currency, surcharges[]).

Estimate in the standard { data, meta } envelope — the resolved channel, to, countryCode, a rate object (ratePerUnit, currency, countryCode) or null when no rate is published, and when allIn=true an allIn object (baseRatePerUnit, currency, surcharges[]).