Get credit balance

GET /v2/credits/balance

Get credit balance

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • credits object

      'Standard' credits balance.

      Additional properties are allowed.

      Hide credits attributes Show credits attributes object
      • oneTime integer

        Number of one-time credits left.

        Default value is 0.

      • recurrent integer

        Number of recurrent credits left.

        Default value is 0.

    • emailCredits object

      'Standard' credits balance.

      Additional properties are allowed.

      Hide emailCredits attributes Show emailCredits attributes object
      • oneTime integer

        Number of one-time credits left.

        Default value is 0.

      • recurrent integer

        Number of recurrent credits left.

        Default value is 0.

    • phoneCredits object

      'Standard' credits balance.

      Additional properties are allowed.

      Hide phoneCredits attributes Show phoneCredits attributes object
      • oneTime integer

        Number of one-time credits left.

        Default value is 0.

      • recurrent integer

        Number of recurrent credits left.

        Default value is 0.

    • dailyLimitRateLeft integer

      Number of requests left for the current day.

      Default value is 0.

    • dailyLimitRateSecondsToReset integer

      Number of seconds left until the daily limit resets.

      Default value is 0.
  • 403 application/json

    Forbidden

    Hide response attribute Show response attribute object
    • detail string Required

      Value is Current API token is not registered in our database.
  • 402 application/json

    Payment Required

    Hide response attribute Show response attribute object
    • detail string Required

      Values are 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, or Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later..
  • 404

    Not found

  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
GET /v2/credits/balance 
curl \
 -X GET https://api.ocean.io/v2/credits/balance?apiToken=string
Response examples (200) 
{
  "credits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "emailCredits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "phoneCredits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "dailyLimitRateLeft": 10,
  "dailyLimitRateSecondsToReset": 3600
}
Response examples (403) 
{
  "detail": "Current API token is not registered in our database"
}
Response examples (402) 
{
  "detail": "Insufficient email credits"
}
Response examples (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}