Billing
Get record counts
Return stored records, overage, and create-blocked state for one Core instance.
GET
/
data
/
record-counts
curl -X GET "https://api.cloud.blnkfinance.com/data/record-counts?instance_id=instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc" \
-H "X-blnk-key: CLOUD_API_KEY"
{
"instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"record_counts": {
"balances": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"identities": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"ledgers": {
"count": 1,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"reconciliations": {
"count": 0,
"total_is_estimate": false,
"total_source": "exact"
},
"transactions": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
}
},
"total_records": 1,
"deployment_type": "sandbox",
"records_included": 100000,
"overage_records": 0,
"overage_unit_price": 0.00135,
"overage_amount": 0,
"usage_billing_enabled": true,
"usage_billing_enabled_at": "2026-09-09T07:20:08.028229Z",
"record_creates_blocked": false
}
{
"error": "Instance ID is required"
}
{
"error": "Instance does not belong to this organization"
}
Use this to see how many records one instance stores, how many sit above the included allowance, and whether new record creates are blocked.
A record is a ledger, balance, transaction, identity, or reconciliation external data stored in the instance. See Usage-based billing.
Authorization
Blnk Cloud APIs support any one of the following authentication methods. All of them work with yourCLOUD_API_KEY or OAUTH_ACCESS_TOKEN.
Pass X-blnk-key: CLOUD_API_KEY or X-blnk-key: OAUTH_ACCESS_TOKEN.
Query
curl -X GET "https://api.cloud.blnkfinance.com/data/record-counts?instance_id=instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc" \
-H "X-blnk-key: CLOUD_API_KEY"
string
required
Cloud instance id (
instance_...). Get it from Get instance details. A deploy_... id does not work.Response
{
"instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"record_counts": {
"balances": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"identities": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"ledgers": {
"count": 1,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"reconciliations": {
"count": 0,
"total_is_estimate": false,
"total_source": "exact"
},
"transactions": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
}
},
"total_records": 1,
"deployment_type": "sandbox",
"records_included": 100000,
"overage_records": 0,
"overage_unit_price": 0.00135,
"overage_amount": 0,
"usage_billing_enabled": true,
"usage_billing_enabled_at": "2026-09-09T07:20:08.028229Z",
"record_creates_blocked": false
}
{
"error": "Instance ID is required"
}
{
"error": "Instance does not belong to this organization"
}
string
Instance that was counted (
instance_...).object
Counts by resource.
Show child attributes
Show child attributes
object
object
Identity records. Same shape as
balances.object
Ledger records. Same shape as
balances.object
Reconciliation records. Same shape as
balances.object
Transaction records. Same shape as
balances.integer
Sum of all record counts.
string
sandbox or production.integer
Records included in the plan allowance.
integer
Records above the included allowance.
number
Price per extra record in the billing currency’s major unit (for example USD), not cents. In the sample,
0.00135 is $0.00135 per extra record.number
Estimated overage charge for the current count, in the billing currency’s major unit (for example USD), not cents.
boolean
Whether usage-based billing is on for the organization.
timestamp
When usage-based billing was enabled for the organization. ISO 8601.
boolean
true when this instance has used its included records and organization usage-based billing is off, so new records cannot be created. false while the instance is within its allowance or usage-based billing is on.Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.Was this page helpful?
⌘I
curl -X GET "https://api.cloud.blnkfinance.com/data/record-counts?instance_id=instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc" \
-H "X-blnk-key: CLOUD_API_KEY"
{
"instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"record_counts": {
"balances": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"identities": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"ledgers": {
"count": 1,
"total_is_estimate": false,
"total_source": "lake_catalog"
},
"reconciliations": {
"count": 0,
"total_is_estimate": false,
"total_source": "exact"
},
"transactions": {
"count": 0,
"total_is_estimate": false,
"total_source": "lake_catalog"
}
},
"total_records": 1,
"deployment_type": "sandbox",
"records_included": 100000,
"overage_records": 0,
"overage_unit_price": 0.00135,
"overage_amount": 0,
"usage_billing_enabled": true,
"usage_billing_enabled_at": "2026-09-09T07:20:08.028229Z",
"record_creates_blocked": false
}
{
"error": "Instance ID is required"
}
{
"error": "Instance does not belong to this organization"
}