/account/credits

GET Free — this endpoint does not consume credits

Coverage n/a

Returns the credit balance, plan allowance and reset date for the API key making the request. Costs nothing to call.

Input

Parameter	Description	Required
`key`	Your API key. May also be sent as a bearer token or X-API-Key header.	Required

Example request

GET request

https://api.ukdatalayer.com/v1/account/credits?key=YOUR_KEY

Output

Field	Type	Description
`plan`	string	explore, starter, build, growth, scale or business.
`credits_remaining`	number	Credits left in the current period.
`credits_allowance`	number	Total credits for the period.
`period_resets_on`	date	Date the allowance resets.

Example response

200 OK · application/json

{
  "status": "success",
  "credits_used": 0,
  "data": {
    "plan": "build",
    "credits_remaining": 22841,
    "credits_allowance": 25000,
    "period_resets_on": "2026-08-01"
  }
}