balance.low

{ "event": "balance.low", "timestamp": "2026-06-23T14:30:00.000Z", "organizationId": "8f14e45f-ceea-4e7a-9c3d-1c2b3a4d5e6f", "mode": "live", "apiVersion": "2026-08-27", "data": { "subscriptionId": "sub_1a2b3c4d", "customerId": "user_123", "currentBalance": 90000, "thresholdBalance": 100000, "currency": "usd" } }

When this fires

The async usage processor watches every balance deduction. When a batch moves the prepaid balance from above to at-or-below 10% of the last refill (period reset, top-up, or manual adjustment), this event fires once per crossing. A top-up re-arms it.

Amounts are in rate scale (10000 = $1.00) in the subscription currency.

Use it to prompt the customer to top up before usage gets blocked.

Body

application/json

string

required

event

string

required

Allowed value: "balance.low"

timestamp

string

required

organizationId

string

required

mode

enum<string>

required

Available options:

live,

sandbox

apiVersion

string

required

data

object

required

Show child attributes

Response

200

Return any 2xx status code to acknowledge receipt of the event.

Overview

Events

When this fires

Body

Response

​When this fires

Body

Response

When this fires