Get credit balance

Retrieve the current user’s credit balance and tier information

GET /api/credits/balance

Get credit balance

cURL

curl --request GET \
  --url https://api.example.com/api/credits/balance

import requests

url = "https://api.example.com/api/credits/balance"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/credits/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/credits/balance"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/credits/balance")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/credits/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "balance": 123,
  "tier": "<string>",
  "tierDisplayName": "<string>",
  "monthlyAllocation": 123,
  "nextRefreshDate": "<string>",
  "stats": {
    "totalEarned": 123,
    "totalSpent": 123,
    "lifetimeBalance": 123
  }
}

Returns the authenticated user’s current credit balance, monthly tier allocation, and tier details.

Request

includeStats · boolean · default: "false"

Include additional statistics (total earned, spent, etc.)

Response

balance · integer · required

Current available credits

tier · string · required

Current tier key (e.g., “free”, “joi-curious”, “full-access”, “vip”)

tierDisplayName · string · required

Human-readable tier name

monthlyAllocation · integer · required

Credits allocated monthly for this tier

nextRefreshDate · string

ISO timestamp of next monthly credit refresh

stats · object

Additional statistics (only if includeStats=true)

Show stats properties

totalEarned · integer

Total credits earned (purchases + referrals)

totalSpent · integer

Total credits spent on features

lifetimeBalance · integer

All-time credit total

Example Request

curl https://your-domain.com/api/credits/balance \
  -H "Cookie: connect.sid=your-session-cookie"

Example Response

{
  "balance": 127,
  "tier": "joi-curious",
  "tierDisplayName": "JOI-Curious",
  "monthlyAllocation": 1000,
  "nextRefreshDate": "2026-04-01T00:00:00.000Z"
}

Response Codes

Code	Description
200	Success - Returns credit balance
401	Unauthorized - User not authenticated
500	Server error

Notes

• Balance is checked before any credit-consuming operation
• Monthly allocations reset on the 1st of each month
• Free tier users receive 50 credits per month
• Premium tiers receive larger monthly allocations (1,000 - 5,000)

Related Endpoints

• Check Feature Cost - Check if user can afford a feature
• Get Transactions - View credit transaction history
• Get Packages - View available credit packages for purchase