Skip to content

basalt / subscriptions/src / PaymentEvent

Interface: PaymentEvent ​

Defined in: subscriptions/src/payment.ts:51

A payment webhook, translated to domain terms — gateway payloads never leak.

Properties ​

amount ​

> amount: number

Defined in: subscriptions/src/payment.ts:57


billableId? ​

> optional billableId?: string

Defined in: subscriptions/src/payment.ts:59

From the request metadata, when the gateway echoes it back.


id ​

> id: string

Defined in: subscriptions/src/payment.ts:53

Unique id at the gateway — for idempotent processing.


paymentId ​

> paymentId: string

Defined in: subscriptions/src/payment.ts:56

The gateway payment/reference id from createPayment.


raw? ​

> optional raw?: unknown

Defined in: subscriptions/src/payment.ts:61


reference? ​

> optional reference?: string

Defined in: subscriptions/src/payment.ts:60


type ​

> type: "payment.failed" | "payment.succeeded"

Defined in: subscriptions/src/payment.ts:54

Released under the MIT License.