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

      'Standart' 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

      'Standart' 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

      'Standart' 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.
  • 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 (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}