credits.purchased

{ "event": "credits.purchased", "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", "invoiceId": "inv_t1u2v3", "invoiceNumber": "INV-0051", "creditPackName": "Booster 500", "credits": 500 } }

When this fires

When a customer buys a credit pack or a chosen quantity of credits through the API, an automatic top-up, or the customer portal, and the payment succeeds. Purchased credits never expire — unlike plan credits, they survive period resets.

Plan-included credits granted at each period reset fire credits.granted instead.

Use it to confirm top-up purchases in your own UI or analytics.

Body

application/json

string

required

event

string

required

Allowed value: "credits.purchased"

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

When this fires

Body

Response

​When this fires

Body

Response

When this fires