balance.topped_up

{ "event": "balance.topped_up", "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", "amount": 500000, "currency": "usd" } }

When this fires

When a customer on a balance plan tops up their prepaid balance through the customer portal and the payment succeeds.

amount is the topped-up value in rate scale (10000 = $1.00 of the subscription currency) — the same scale balance.low and balance.depleted use.

Use it to confirm the top-up in your own UI and to clear any low-balance warnings you raised on balance.low.

Body

application/json

string

required

event

string

required

Allowed value: "balance.topped_up"

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

balance.topped_up

When this fires

Body

Response

​When this fires

Body

Response

When this fires