Interface: DeductWithAllowanceOptions

Defined in: javascript/src/types.ts:117

Options for an atomic allowance-aware deduction.

Properties

feature?

optional feature?: string | null

Defined in: javascript/src/types.ts:125

Feature name tagged onto the transaction and checked against featureLimit.

---

featureLimit?

optional featureLimit?: FeatureLimit | null

Defined in: javascript/src/types.ts:127

The resolved FeatureLimit for feature (looked up from the user's plan). null/omitted skips enforcement.

---

featurePeriodStart?

optional featurePeriodStart?: Date | null

Defined in: javascript/src/types.ts:134

Calendar-aligned window start for featureLimit.period (resolved via resolveCalendarWindow). Mirrors Python base.py: only the start is threaded down — the store derives the window end itself from featureLimit.period.

---

idempotencyKey?

optional idempotencyKey?: string | null

Defined in: javascript/src/types.ts:118

---

metadata?

optional metadata?: CreditMetadata | null

Defined in: javascript/src/types.ts:121

---

minBalance?

optional minBalance?: Decimal

Defined in: javascript/src/types.ts:119

---

model?

optional model?: string | null

Defined in: javascript/src/types.ts:120

---

periodStart?

optional periodStart?: Date | null

Defined in: javascript/src/types.ts:123

Free-allowance window start override (WS9); defaults to calendar-month when omitted.