credits.expired

{ "event": "credits.expired", "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", "expiredCredits": 120 } }

When this fires

Plan credits expire at the end of each billing period: the period reset discards whatever remained and grants the new period’s credits (which fires credits.granted). This event reports the discarded amount. Purchased credits never expire and are not affected.

It only fires when there was something to discard — a customer who used all plan credits gets no credits.expired.

Use it for end-of-period usage summaries (“you left 120 credits on the table”).

Body

application/json

string

required

event

string

required

Allowed value: "credits.expired"

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.expired

When this fires

Body

Response

​When this fires

Body

Response

When this fires