credits.depleted

{ "event": "credits.depleted", "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": 0 } }

When this fires

The async usage processor fires this once when a deduction moves the credit balance from positive to zero. From this point, usage requests that need more credits than remain are rejected with insufficient_credits.

customer.state_changed fires alongside it with trigger credits_depleted, carrying the customer’s full current entitlement state.

Use it to block gated features in your app and drive the customer to a credit pack purchase.

Body

application/json

string

required

event

string

required

Allowed value: "credits.depleted"

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

credits.depleted

When this fires

Body

Response

​When this fires

Body

Response

When this fires