Skip to main content
Version: Next

ChargeResult

Index

Properties

chargeableWithinLimit

chargeableWithinLimit: Record<string, number>

A record showing how many events of each type can still be charged within the budget limit.

The keys are event names and the values are the maximum number of events of that type that can still be charged without exceeding maxTotalChargeUsd. This provides a comprehensive view of remaining budget capacity across all event types.

Use this field when you need flexible budget management across multiple event types, rather than relying on eventChargeLimitReached which only applies to the current event.

chargedCount

chargedCount: number

The actual number of events that were successfully charged.

This may be less than the requested count if charging the full amount would exceed the maximum total charge limit (maxTotalChargeUsd).

eventChargeLimitReached

eventChargeLimitReached: boolean

Whether the charge limit was reached for the specific event type that was being charged.

When true, it means no more events of this specific type can be charged without exceeding the total budget limit. This does NOT mean the limit for all events was reached - other event types might still be chargeable.

For more flexible budget checking across all event types, use the chargeableWithinLimit field.