get /v2/credits/balance

Get credit balance

Authorizations

apiToken string
x-api-token string

Responses

200 Successful Response
'Standard' credits balance.
oneTime number
Number of one-time credits left.
recurrent number
Number of recurrent credits left.
'Email' credits balance.
oneTime number
Number of one-time credits left.
recurrent number
Number of recurrent credits left.
'Phone' credits balance.
oneTime number
Number of one-time credits left.
recurrent number
Number of recurrent credits left.
'Preview' credits balance.
oneTime number
Number of one-time credits left.
recurrent number
Number of recurrent credits left.
dailyLimitRateLeft integer
Number of requests left for the current day.
dailyLimitRateSecondsToReset integer
Number of seconds left until the daily limit resets.
400 Bad Request
detail enum Required
"Conflicting API tokens provided in query parameters and headers"
402 Payment Required
detail enum Required
"Insufficient email credits""Some email verifications are already in progress and might use all your remaining email credits. Please try again later.""Insufficient phone credits""Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later.""Insufficient credits"
403 Forbidden
detail enum Required
"API token should be provided in headers or query parameters""Current API token is not registered in our database"
404 Not found
422 Validation Error
Array of ValidationError
Array of string | integer
string | integer
msg string Required
type string Required
input any
object