Account

Get your balance

Returns your plan, your available credits and the credits held by checks that are still running. On the unlimited plan unlimited is true and available is null. Requires scope credits:read.

get/v1/credits

Request

  • Base URL: https://platform.detectif.ai
  • URL: https://platform.detectif.ai/v1/credits
  • Auth: HTTP bearer

Response

Success.

request_idstring required
object'credits' required
plan'free' | 'unlimited' required

Your plan.

unlimitedboolean required

true on the unlimited plan: checks use no credits and available is null.

availableinteger nullable required

Credits you can use; null on the unlimited plan.

reservedinteger required

Credits held by checks that are still running.

price_per_operationinteger required

Credits one completed check uses (0 on the unlimited plan).

Changes

No recorded changes to this operation across all 1 revision of this API.