Credits

Get credit balance

Read the credits available in the account connected to your access token. You do not need an account, workspace, or collection ID. The token needs credits:read or account-wide admin scope.

remainingCredits combines your monthly credits and top-up credits. Monthly credits are used first. Amounts are decimal strings with up to nine decimal places.

The balance includes usage received so far; pending usage can reduce it later. Reading it does not reserve credits for another task. Completed top-ups appear after settlement; this endpoint does not make or settle a purchase.

Required permissions: credits:read

get/v1/credits/balance

Authorizations

Authorizationstringheaderrequired

Use an account access token as Bearer <token>.

Get an access token ↗

Response

Aggregate balance after reconciling received usage.

200 · application/json

Additional properties are not allowed.

remainingCreditsstringrequired

Monthly allocation plus top-up credits currently available.

pattern: "^[0-9]+(?:\\.[0-9]{1,9})?$"

monthlyBalanceRemainingCreditsstringrequired

Credits remaining in the active allocation, consumed first.

pattern: "^[0-9]+(?:\\.[0-9]{1,9})?$"

balanceRemainingCreditsstringrequired

Settled top-up credits remaining.

pattern: "^[0-9]+(?:\\.[0-9]{1,9})?$"

Get credit balance

import requests

url = "https://api.datablist.com/v1/credits/balance"

headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

Response

{
  "remainingCredits": "12500.5",
  "monthlyBalanceRemainingCredits": "10000",
  "balanceRemainingCredits": "2500.5"
}