import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.balances.countLedger({
customerId: "cus_123",
featureId: "messages",
customRange: {
start: 1759276800000,
end: 1761868800000,
},
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.balances.count_ledger(
customer_id="cus_123",
feature_id="messages",
custom_range={
"start": 1759276800000,
"end": 1761868800000,
},
)curl --request POST \
--url https://api.useautumn.com/v1/balances.count_ledger \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"customer_id": "cus_123",
"feature_id": "messages",
"custom_range": {
"start": 1759276800000,
"end": 1761868800000
}
}
'{
"entity_id": null,
"coverage": {
"recording": true,
"since": 1759300000000
},
"counts": {
"usage": 9412,
"top_ups": 2,
"resets": 1,
"plan_changes": 0,
"adjustments": 1
},
"complete": true
}
Count Balance Ledger
Counts the entries of each type that balances.list_ledger lists for one customer’s balance of a feature over a range, for showing beside a filter by type.
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.balances.countLedger({
customerId: "cus_123",
featureId: "messages",
customRange: {
start: 1759276800000,
end: 1761868800000,
},
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.balances.count_ledger(
customer_id="cus_123",
feature_id="messages",
custom_range={
"start": 1759276800000,
"end": 1761868800000,
},
)curl --request POST \
--url https://api.useautumn.com/v1/balances.count_ledger \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"customer_id": "cus_123",
"feature_id": "messages",
"custom_range": {
"start": 1759276800000,
"end": 1761868800000
}
}
'{
"entity_id": null,
"coverage": {
"recording": true,
"since": 1759300000000
},
"counts": {
"usage": 9412,
"top_ups": 2,
"resets": 1,
"plan_changes": 0,
"adjustments": 1
},
"complete": true
}
custom_range or recorded_range. Pass a type to types on List Balance Ledger to list only the entries of that type.
counts.usage counts usage events, not entries: each track once, and a lock once, when it was reserved. The other counts are how many entries List Balance Ledger lists for that type when types leaves out usage: adjustments counts recorded edits only (updates that don’t add to the balance, deletes and recalculations), not an adjustment Autumn works out from a balance that moved with no record. The counts don’t depend on types, so fetch them once per range.
coverage says whether it is for this one. Tracks are kept for 90 days, so counts.usage counts only the tracks in that time.complete is false when the count couldn’t cover the whole range; each count is then at least its value.
Body Parameters
Response
{
"entity_id": null,
"coverage": {
"recording": true,
"since": 1759300000000
},
"counts": {
"usage": 9412,
"top_ups": 2,
"resets": 1,
"plan_changes": 0,
"adjustments": 1
},
"complete": true
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
The customer whose balance history to count.
1The feature whose balance to count, as in balances.list_ledger.
1Count this entity's balance of the feature, as in balances.list_ledger.
1Only count entries that happened in this range.
Show child attributes
Show child attributes
Only count entries Autumn recorded in this range.
Show child attributes
Show child attributes
Response
OK
The entity whose own balance is counted, or null for the customer's.
How much of this customer's balance history Autumn holds. Balance history is rolling out and isn't available for every customer yet; coverage says whether it is for this one.
Show child attributes
Show child attributes
How many entries of each type the range holds, as balances.list_ledger's types filter lists them.
Show child attributes
Show child attributes
False when the count couldn't cover the whole range; each count is then at least its value.