Other

Get credit balance

Get credit balance

GET
/v2/credits/balance

Query Parameters

apiToken?string | null

Header Parameters

x-api-token?string | null

Response Body

curl -X GET "https://api.ocean.io/v2/credits/balance?apiToken=string" \
  -H "x-api-token: string"
{
  "credits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "emailCredits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "phoneCredits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "dailyLimitRateLeft": 10,
  "dailyLimitRateSecondsToReset": 3600
}
{
  "detail": "Conflicting API tokens provided in query parameters and headers"
}
{
  "detail": "Insufficient email credits"
}
{
  "detail": "API token should be provided in headers or query parameters"
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}