Payload

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.

subscriptionIdstring

The subscription ID.

customerIdstring

The customer ID. Returns your externalId if you provided one when creating the customer, otherwise returns the Commet publicId.

remainingCreditsnumber

Total credits remaining (plan plus purchased).

thresholdCreditsnumber

The low-credit threshold that was crossed: 10% of the period's granted plan credits.

periodCreditsnumber

The plan credits granted at the last period reset.

{
  "event": "credits.low",
  "timestamp": "2026-06-18T09:12:00.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "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.