Lifecycle API

Get bill status

Read normalized lifecycle state, balances, and the latest event position.

GEThttps://app.mindbill.org/partner/v2/bills/{billId}/status

Use this for compact status surfaces or an on-demand refresh. Use events or webhooks for durable synchronization.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: bills:read · Browser: bills:read

IdempotencyNot required

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Path parameters

FieldTypeDescription

billIdRequired

string

The MindBill bill identifier returned after atomic submission.

Examples

curl https://app.mindbill.org/partner/v2/bills/$BILL_ID/status \
  --header "Authorization: Bearer $MINDBILL_API_KEY"

Response

200 OK

{
  "data": {
    "billId": "bill_01J6Y7F4Q4XK6P3J9G2C8A1B5D",
    "externalId": "report_9f7a",
    "state": "processed",
    "nativeStatus": "EOR posted",
    "totalCharge": 2015,
    "totalPaid": 0,
    "balanceDue": 2015,
    "lastEventId": "evt_01J6Z2",
    "updatedAt": "2026-08-29T18:42:11.000Z"
  }
}

FieldTypeDescription

data.billIdRequired

string

Bill identifier.

data.externalIdRequired

string | null

Your source-system identifier.

data.stateRequired

string

Normalized lifecycle state used for UI and automation.

data.nativeStatusRequired

string | null

More specific payer or internal status when available.

data.totalChargeRequired

number

Total submitted charge.

data.totalPaidRequired

number

Total payments posted.

data.balanceDueRequired

number

Current unpaid balance.

data.lastEventIdRequired

string | null

Latest lifecycle event reflected in this status.

data.updatedAtRequired

string | null

ISO timestamp of the latest status update.