comecerodocs
Usage entitlements

Get an entitlement's balance

GET
/usage/entitlements/{entitlement_id}/balance

For a credit entitlement, the credit left in the agreement's currency. Secret and trusted tokens may call it; a limited token may not (403).

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

entitlement_id*string

The entitlement id.

Query Parameters

billing_region?string

The entitlement's region. Defaults to us.

Response Body

Success.

application/json
  1. response
object?string

Always entitlement_balance.

entitlement_id?string

The entitlement.

balance?number

For a credit: the credit left, in the agreement's currency.

entries?integer

How many ledger entries there are. 0 before anything is written.

date_computed?string

When the balance was last worked out. Empty before anything is written.

Formatdate-time
billing_region?string

Billing region. Defaults to us.

Value in"us""uk""eu"
Example Request
curl -X GET 'https://api.comecero.com/api/v1/usage/entitlements/string/balance'
Example Response
{  "object": "entitlement_balance",  "entitlement_id": "credit_cust_8412",  "balance": 37.5,  "entries": 3,  "date_computed": "2026-12-01T00:20:11Z",  "billing_region": "us"}

Get an entitlement GET

One entitlement. Secret and trusted tokens may call it; a limited token may not (`403`).

Add prepaid credit POST

Adds credit to a `credit` entitlement. The same `idempotency_key` adds it once; with another amount it answers `409`. Secret and trusted tokens may call it; a limited token may not (`403`).