Get ledger
curl --request GET \
--url https://api.example.com/v1/ledgerimport requests
url = "https://api.example.com/v1/ledger"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/ledger', 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/v1/ledger",
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/v1/ledger"
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/v1/ledger")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/ledger")
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{
"user_id": "user_abc123",
"plan": "creator",
"plan_pool": 1000,
"plan_resets_at": 1736208000000,
"balance": 742,
"pending": 18,
"available": 724,
"transactions": [
{ "ts": 1733991122000, "kind": "commit", "amount": -10, "label": "video / 5s" },
{ "ts": 1733991100000, "kind": "reserve", "amount": 10, "token": "rsv_..." }
]
}
Ledger
Get ledger
Credit balance, plan, pending reservations, recent transactions.
GET
/
v1
/
ledger
Get ledger
curl --request GET \
--url https://api.example.com/v1/ledgerimport requests
url = "https://api.example.com/v1/ledger"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/ledger', 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/v1/ledger",
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/v1/ledger"
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/v1/ledger")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/ledger")
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{
"user_id": "user_abc123",
"plan": "creator",
"plan_pool": 1000,
"plan_resets_at": 1736208000000,
"balance": 742,
"pending": 18,
"available": 724,
"transactions": [
{ "ts": 1733991122000, "kind": "commit", "amount": -10, "label": "video / 5s" },
{ "ts": 1733991100000, "kind": "reserve", "amount": 10, "token": "rsv_..." }
]
}
{
"user_id": "user_abc123",
"plan": "creator",
"plan_pool": 1000,
"plan_resets_at": 1736208000000,
"balance": 742,
"pending": 18,
"available": 724,
"transactions": [
{ "ts": 1733991122000, "kind": "commit", "amount": -10, "label": "video / 5s" },
{ "ts": 1733991100000, "kind": "reserve", "amount": 10, "token": "rsv_..." }
]
}
| Field | Meaning |
|---|---|
balance | Confirmed credits remaining. |
pending | Sum of outstanding reserves. |
available | balance - pending, what you can spend right now. |
plan_pool | Monthly allocation for the active plan. |
plan_resets_at | When the monthly pool refills. Unspent credits carry over. |
Was this page helpful?
⌘I