credits.granted

{ "event": "credits.granted", "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", "credits": 500, "reason": "period_reset" } }

When this fires

Plan-included credits are granted at the start of every billing period (reason: "period_reset"), and manual adjustments from the dashboard grant purchased credits (reason: "manual_adjustment"). Purchases through the API, automatic top-ups, or the customer portal fire credits.purchased instead.

The idempotency key is derived from the billing operation that granted the credits, so engine retries never send a duplicate.

Use it to reset in-app usage meters at the start of a period or to confirm a support-driven credit grant reached the customer.

Body

application/json

string

required

event

string

required

Allowed value: "credits.granted"

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

When this fires

Body

Response

​When this fires

Body

Response

When this fires