Get account credit balance

curl --request GET \
  --url https://api.crustdata.com/account/credits \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-version: <x-api-version>'

import requests

url = "https://api.crustdata.com/account/credits"

headers = {
    "x-api-version": "<x-api-version>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-version': '<x-api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.crustdata.com/account/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "account": {
    "credits": 964501.02,
    "recurring_credits": 0,
    "recurring_credits_frequency": null,
    "recurring_credits_refresh_date": null
  }
}

Account credit balance

Returns the account’s remaining credit balance together with the recurring credit grant: the grant size, how often it refreshes, and the next refresh date.

Accounts with credit wallets enabled also receive a wallets list — the recurring wallet (refreshed each cycle, spent first) and the top-up wallet (purchased credits that roll over until their expiry date). The key is absent for accounts without wallets. Always gate spending decisions on account.credits; wallets is informational.

Accounts with live top-ups additionally receive a credit_topups list — one entry per top-up still holding credits, with its origin (purchase, auto_topup, or granted), original and remaining credits, and expiry date, sorted soonest expiry first. The key is absent otherwise.

This endpoint is free and consumes no credits. It is rate limited to 300 requests per minute. It requires the x-api-version: 2025-11-01 header — requests without it return 400.

GET

https://api.crustdata.com

account

credits

Get account credit balance

curl --request GET \
  --url https://api.crustdata.com/account/credits \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-version: <x-api-version>'

import requests

url = "https://api.crustdata.com/account/credits"

headers = {
    "x-api-version": "<x-api-version>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-version': '<x-api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.crustdata.com/account/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "account": {
    "credits": 964501.02,
    "recurring_credits": 0,
    "recurring_credits_frequency": null,
    "recurring_credits_refresh_date": null
  }
}

Authorizations

Authorization

string

header

required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version

enum<string>

default:2025-11-01

required

API version to use. This endpoint currently requires 2025-11-01. Requests without the header, or with any other value, return 400.

Available options:

2025-11-01

Example:

"2025-11-01"

Response

Credit balance and recurring-grant details for the account.

The response is small and fixed: a single account object with four keys, plus wallets and credit_topups on accounts that have credit wallets enabled. The three examples cover every shape you can get back.

Wrapper object for the account credit summary. The balance always sits under the account key, never at the top level.

account

object

required

Credit balance and recurring-grant details for the account.

Show child attributes