Reserve credits - Alguna Docs

POST

credits

check

Reserve credits

curl --request POST \
  --url https://api.alguna.io/credits/check \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": "cust_abc123",
  "feature": "llm_tokens",
  "event_name": "api_call",
  "properties": {},
  "reserve": "100"
}
'

import requests

url = "https://api.alguna.io/credits/check"

payload = {
    "account": "cust_abc123",
    "feature": "llm_tokens",
    "event_name": "api_call",
    "properties": {},
    "reserve": "100"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account: 'cust_abc123',
    feature: 'llm_tokens',
    event_name: 'api_call',
    properties: {},
    reserve: '100'
  })
};

fetch('https://api.alguna.io/credits/check', 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.alguna.io/credits/check",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account' => 'cust_abc123',
    'feature' => 'llm_tokens',
    'event_name' => 'api_call',
    'properties' => [
        
    ],
    'reserve' => '100'
  ]),
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.alguna.io/credits/check"

	payload := strings.NewReader("{\n  \"account\": \"cust_abc123\",\n  \"feature\": \"llm_tokens\",\n  \"event_name\": \"api_call\",\n  \"properties\": {},\n  \"reserve\": \"100\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.alguna.io/credits/check")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": \"cust_abc123\",\n  \"feature\": \"llm_tokens\",\n  \"event_name\": \"api_call\",\n  \"properties\": {},\n  \"reserve\": \"100\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/credits/check")

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

request = Net::HTTP::Post.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": \"cust_abc123\",\n  \"feature\": \"llm_tokens\",\n  \"event_name\": \"api_call\",\n  \"properties\": {},\n  \"reserve\": \"100\"\n}"

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

{
  "allowed": true,
  "at_zero_action": "overflow",
  "balance": "<string>",
  "covered": "<string>",
  "reservation_id": "crt_abc123",
  "shortfall": "<string>",
  "expires_at": "2026-04-01T10:05:00Z"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

Authorizations

Authorization

string

header

required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version

enum<string>

required

Available options:

2026-04-01

Idempotency-Key

string

A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.

Maximum string length: 255

Example:

"ik_a1b2c3d4e5f6"

Body

application/json

account

string

required

Customer account ID or alias the credits belong to

Example:

"cust_abc123"

feature

string

required

Feature (billable metric name) the credits are consumed against

Example:

"llm_tokens"

event_name

string | null

Usage event name, when the check should be resolved against a specific event's pricing context

Example:

"api_call"

properties

object

Event properties used to resolve customer-specific filter groups. Never a billing source of truth.

reserve

string | null

Amount of credits to hold up front. Omit for a cost-free preflight allow/deny check (no hold is opened).

Example:

"100"

Response

Success

allowed

boolean

required

Whether the requested amount is covered by available credit

at_zero_action

string

required

The feature's at-zero policy the caller should apply on a deny: stop (hard deny) or overflow (fall through to metered billing)

Example:

"overflow"

balance

string

required

Available credit balance for the account (balance − reserved)

covered

string

required

Amount of the request covered by available credit

reservation_id

string

required

Reservation token to settle later via /track. Empty unless a hold was opened (reserve).

Example:

"crt_abc123"

shortfall

string

required

Amount by which the request exceeded available credit (0 when fully covered)

expires_at

string<date-time> | null

When the opened hold expires. Present only when a reservation was opened.

Example:

"2026-04-01T10:05:00Z"

Track credit consumptionRecords credit consumption in one of two forms: draw an ad-hoc cost against the account's open block (feature + cost), or settle a prior reservation with the amount used (reservation_id + used). A deny is returned as `200 { allowed: false }`. Settlement is idempotent — a retry with the same Idempotency-Key replays the recorded outcome instead of double-settling.

⌘I

Reserve credits

curl --request POST \
  --url https://api.alguna.io/credits/check \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": "cust_abc123",
  "feature": "llm_tokens",
  "event_name": "api_call",
  "properties": {},
  "reserve": "100"
}
'

import requests

url = "https://api.alguna.io/credits/check"

payload = {
    "account": "cust_abc123",
    "feature": "llm_tokens",
    "event_name": "api_call",
    "properties": {},
    "reserve": "100"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account: 'cust_abc123',
    feature: 'llm_tokens',
    event_name: 'api_call',
    properties: {},
    reserve: '100'
  })
};

fetch('https://api.alguna.io/credits/check', 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.alguna.io/credits/check",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account' => 'cust_abc123',
    'feature' => 'llm_tokens',
    'event_name' => 'api_call',
    'properties' => [
        
    ],
    'reserve' => '100'
  ]),
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.alguna.io/credits/check"

	payload := strings.NewReader("{\n  \"account\": \"cust_abc123\",\n  \"feature\": \"llm_tokens\",\n  \"event_name\": \"api_call\",\n  \"properties\": {},\n  \"reserve\": \"100\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.alguna.io/credits/check")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": \"cust_abc123\",\n  \"feature\": \"llm_tokens\",\n  \"event_name\": \"api_call\",\n  \"properties\": {},\n  \"reserve\": \"100\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/credits/check")

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

request = Net::HTTP::Post.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": \"cust_abc123\",\n  \"feature\": \"llm_tokens\",\n  \"event_name\": \"api_call\",\n  \"properties\": {},\n  \"reserve\": \"100\"\n}"

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

{
  "allowed": true,
  "at_zero_action": "overflow",
  "balance": "<string>",
  "covered": "<string>",
  "reservation_id": "crt_abc123",
  "shortfall": "<string>",
  "expires_at": "2026-04-01T10:05:00Z"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}