Open Dashboard

This feature is only available in the Enterprise version

Billing

Get record counts

Return stored records, overage, and create-blocked state for one Core instance.

GET/data/record-counts

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.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Query

instance_idstringrequiredquery

Cloud instance id (instance_...). Get it from Get instance details. A deploy_... id does not work.

Response

instance_idstring

Instance that was counted (instance_...).

record_countsobject

Counts by resource.

total_recordsinteger

Sum of all record counts.

deployment_typestring

sandbox or production.

records_includedinteger

Records included in the plan allowance.

overage_recordsinteger

Records above the included allowance.

overage_unit_pricenumber

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.

overage_amountnumber

Estimated overage charge for the current count, in the billing currency’s major unit (for example USD), not cents.

usage_billing_enabledboolean

Whether usage-based billing is on for the organization.

usage_billing_enabled_attimestamp

When usage-based billing was enabled for the organization. ISO 8601.

record_creates_blockedboolean

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.