cURL
curl --request GET --fail-with-body --max-time 30 \
"${AMLOK_API_BASE_URL}/v1/billing/credit-ledger?snapshot_id=billing_snapshot_example&limit=100" \
--header "Authorization: Bearer ${AMLOK_API_KEY}" \
--header "Accept: application/json"import os
import requests
base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]
response = requests.request(
"GET", base_url + "/v1/billing/credit-ledger?snapshot_id=billing_snapshot_example&limit=100",
headers=headers, timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(response.json())
const baseUrl = process.env.AMLOK_API_BASE_URL;
const apiKey = process.env.AMLOK_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Configure AMLOK_API_BASE_URL and AMLOK_API_KEY");
const headers = {
"Accept": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/billing/credit-ledger?snapshot_id=billing_snapshot_example&limit=100", {
method: "GET", headers,
redirect: "error", signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());{
"data": [
{
"id": "ledger_funding_example",
"object": "billing_credit_entry",
"record_version": 1,
"created_at": "2026-09-30T14:00:00Z",
"updated_at": "2026-09-30T14:00:00Z",
"workspace_id": "wsp_example",
"billing_account_id": "billing_account_example",
"sequence": 1,
"currency": "CAD",
"amount": "12000.00",
"balance_after": "12000.00",
"entry_type": "funding",
"movement_id": "billing_funding_example",
"reverses_entry_id": null,
"posted_at": "2026-09-30T14:00:00Z",
"client_reference": "annual-prepayment",
"snapshot_id": "billing_snapshot_example"
},
{
"id": "ledger_signal_example",
"object": "billing_credit_entry",
"record_version": 1,
"created_at": "2026-10-01T00:00:00Z",
"updated_at": "2026-10-01T00:00:00Z",
"workspace_id": "wsp_example",
"billing_account_id": "billing_account_example",
"sequence": 2,
"currency": "CAD",
"amount": "-3.00",
"balance_after": "11997.00",
"entry_type": "usage",
"movement_id": "billing_usage_signal",
"reverses_entry_id": null,
"posted_at": "2026-10-01T00:00:00Z",
"client_reference": "signal-october",
"snapshot_id": "billing_snapshot_example"
},
{
"id": "billing_credit_entry_example",
"object": "billing_credit_entry",
"record_version": 1,
"created_at": "2026-10-23T14:00:00Z",
"updated_at": "2026-10-23T14:00:00Z",
"workspace_id": "wsp_example",
"billing_account_id": "billing_account_example",
"sequence": 3,
"currency": "CAD",
"amount": "-5.00",
"balance_after": "11992.00",
"entry_type": "usage",
"movement_id": "billing_usage_example",
"reverses_entry_id": null,
"posted_at": "2026-10-23T14:00:00Z",
"client_reference": "insights-october",
"snapshot_id": "billing_snapshot_example"
}
],
"page": {
"has_more": false,
"next_cursor": null,
"limit": 100
},
"meta": {
"request_id": "req_example",
"schema_version": "1.4.2",
"generated_at": "2026-10-23T14:00:00Z",
"data_status": "complete"
}
}
Reporting
List credit ledger entries
Read posted credit additions, product consumption, reconciliation adjustments and final-cancellation refunds. Entries are immutable and returned in ascending sequence order at a stable snapshot. The customer cannot create or change ledger entries. Read a statement or export for period reconciliation.
Required scope: billing:read. The API key is bound to exactly one workspace, institution and environment. There is no workspace override; this binding applies to every read and export.
GET
/
v1
/
billing
/
credit-ledger
cURL
curl --request GET --fail-with-body --max-time 30 \
"${AMLOK_API_BASE_URL}/v1/billing/credit-ledger?snapshot_id=billing_snapshot_example&limit=100" \
--header "Authorization: Bearer ${AMLOK_API_KEY}" \
--header "Accept: application/json"import os
import requests
base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]
response = requests.request(
"GET", base_url + "/v1/billing/credit-ledger?snapshot_id=billing_snapshot_example&limit=100",
headers=headers, timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(response.json())
const baseUrl = process.env.AMLOK_API_BASE_URL;
const apiKey = process.env.AMLOK_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Configure AMLOK_API_BASE_URL and AMLOK_API_KEY");
const headers = {
"Accept": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/billing/credit-ledger?snapshot_id=billing_snapshot_example&limit=100", {
method: "GET", headers,
redirect: "error", signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());{
"data": [
{
"id": "ledger_funding_example",
"object": "billing_credit_entry",
"record_version": 1,
"created_at": "2026-09-30T14:00:00Z",
"updated_at": "2026-09-30T14:00:00Z",
"workspace_id": "wsp_example",
"billing_account_id": "billing_account_example",
"sequence": 1,
"currency": "CAD",
"amount": "12000.00",
"balance_after": "12000.00",
"entry_type": "funding",
"movement_id": "billing_funding_example",
"reverses_entry_id": null,
"posted_at": "2026-09-30T14:00:00Z",
"client_reference": "annual-prepayment",
"snapshot_id": "billing_snapshot_example"
},
{
"id": "ledger_signal_example",
"object": "billing_credit_entry",
"record_version": 1,
"created_at": "2026-10-01T00:00:00Z",
"updated_at": "2026-10-01T00:00:00Z",
"workspace_id": "wsp_example",
"billing_account_id": "billing_account_example",
"sequence": 2,
"currency": "CAD",
"amount": "-3.00",
"balance_after": "11997.00",
"entry_type": "usage",
"movement_id": "billing_usage_signal",
"reverses_entry_id": null,
"posted_at": "2026-10-01T00:00:00Z",
"client_reference": "signal-october",
"snapshot_id": "billing_snapshot_example"
},
{
"id": "billing_credit_entry_example",
"object": "billing_credit_entry",
"record_version": 1,
"created_at": "2026-10-23T14:00:00Z",
"updated_at": "2026-10-23T14:00:00Z",
"workspace_id": "wsp_example",
"billing_account_id": "billing_account_example",
"sequence": 3,
"currency": "CAD",
"amount": "-5.00",
"balance_after": "11992.00",
"entry_type": "usage",
"movement_id": "billing_usage_example",
"reverses_entry_id": null,
"posted_at": "2026-10-23T14:00:00Z",
"client_reference": "insights-october",
"snapshot_id": "billing_snapshot_example"
}
],
"page": {
"has_more": false,
"next_cursor": null,
"limit": 100
},
"meta": {
"request_id": "req_example",
"schema_version": "1.4.2",
"generated_at": "2026-10-23T14:00:00Z",
"data_status": "complete"
}
}
Required scope:
billing:read
Read posted credit additions, product consumption, reconciliation adjustments and final-cancellation refunds. Entries are immutable and returned in ascending sequence order at a stable snapshot. The customer cannot create or change ledger entries. Read a statement or export for period reconciliation.
Required scope: billing:read. The API key is bound to exactly one workspace, institution and environment. There is no workspace override; this binding applies to every read and export.
Product scope · Processing lifecycle · ErrorsAuthorizations
Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.
Query Parameters
Read entries after this exclusive billing account sequence.
Required range:
x >= 0Inclusive UTC boundary; provide with to.
Exclusive UTC boundary; provide with from.
Movement type.
Available options:
funding, usage, refund, adjustment, reversal Reuse an immutable snapshot from this workspace. Omit to use a current snapshot. Cursors bind this value; unknown snapshots return 404 and conflicting cursor parameters return 400.
Page size; default 100, maximum 200.
Required range:
1 <= x <= 200Opaque cursor bound to filters and a stable snapshot.