Errors and billing

What you pay for

Only successful (2xx) requests are billed. If a request fails for any reason - a bad payload, a generator error, a failed billing check - nothing is charged, so retrying never costs you double.

• Account key - each successful request is deducted from your balance.
• Package key - each successful request uses one call from the package. A package key never falls back to your balance: once the package has ended, its key gets 402.

Billed endpoints are the sensor endpoints, such as /akamai-web/v3/sensor, /akamai-web/sbsd/sensor and /akamai-bmp/ios/sensor. Get Balance, Send feedback and /akamai-bmp/ios/init are free.

Check what's left at any time with Get Balance, or on the dashboard.

Error responses

Errors always have the same shape:

{"error": "insufficient balance"}

Status	error	Cause	What to do
401	X-Api-Key header is required	The header is missing or empty.	Send your key in X-Api-Key.
401	account not found	The key is unknown, e.g. it was rolled.	Copy the current key from the dashboard.
401	inactive account, please contact support	Account key on a suspended or disabled account.	Contact support.
402	insufficient balance	Account key; your balance doesn't cover the request.	Add funds in the dashboard.
402	package is exhausted or expired	Package key; no calls left, the package expired, or the account isn't active.	Buy a new package, or use your account key.
403	package does not cover this product	Package key used on a product that isn't in the package.	Use your account key or a package that includes the product.
503	billing unavailable	Billing is temporarily unavailable.	Retry with backoff.
500		Internal error.	Retry; if it persists, contact us with the X-Request-Id.

401, 402 and 403 won't succeed on retry until the key, balance or package is fixed. 500 and 503 are safe to retry, since failed requests aren't billed.

Each endpoint also returns 400 with a descriptive message when the request payload is invalid.