Remaining API credit balance

GET https://api.iconscout.com/v3/credits

Two meters, reported together so you can budget from one call.

credits is the API credit wallet: one balance spanning every metered API product. Conversions and AI operations draw on it, and asset downloads do too — except on the free plan, where conversions and AI spend one_time_credits, a grant that never refills. downloads is the separate per-asset allowance carried on your own subscription rows, which is what an asset download spends against.

They are reported together but never summed — the units differ, and a single download can move both. Read the meter that matches the call you made: on a paid plan a conversion or generation moves credits only, while on the free plan it moves credits.one_time_credits only; a download moves downloads and the wallet on either.

included_credits reflects your own plan, so read it from this endpoint rather than assuming a figure. Free billing periods run from the day the app was created, not from the 1st of the month, so period_start will not usually be a month boundary. For plans and pricing, see iconscout.com/api.

Responses

StatusMeaning
200 Wallet balance and period, plus the per-asset download allowances
401 Missing or invalid client credentials. data.reason is invalid_credentials.
422 This client holds no active API subscription. data.reason is subscription_required.
429 Rate limit exceeded for this client. data.reason is rate_limit_exceeded.\n\nLimits are per client, per product family and per method, and are set by your plan — support can raise them for an individual client. Read the X-RateLimit-* headers, which are returned on every response the limiter admits and not only this one, rather than hard-coding a number; back off on Retry-After. They are absent only where the call is refused before the limiter runs — a 401 on invalid credentials.\n\nDistinct from the credit allowance, which refuses with quota_exhausted and is not cleared by waiting.
Try it in the interactive reference →