credits.low

{ "event": "credits.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", "remainingCredits": 42, "thresholdCredits": 50, "periodCredits": 500 } }

When this fires

The async usage processor watches every credit deduction. When a batch of usage moves the remaining credits (plan plus purchased) from above to at-or-below 10% of the credits granted at the last period reset, this event fires once. It does not re-fire while the balance stays low, and the next period reset re-arms it.

If a single burst of usage jumps straight past zero, only credits.depleted fires.

Use it to prompt the customer to buy a credit pack before they hit zero.

Body

application/json

string

required

event

string

required

Allowed value: "credits.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