Interface: PlanDefinition

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

Definition of a subscription plan with free allowance and rate overrides.

Beyond allowance/rates/features, a plan carries the financial-safety policy (interface plan §1): a defaultBillingMode for the whole plan, optional perOperation overrides keyed by operation type, and plan-wide maxConcurrent / overdraftFloor defaults.

Properties

allowancePeriod?

optional allowancePeriod?: AllowancePeriod

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

Free-allowance reset window mode (WS9). Defaults to "calendar_month" when absent.

---

defaultBillingMode?

optional defaultBillingMode?: BillingMode

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

---

featureLimits?

optional featureLimits?: Record<string, FeatureLimit> | null

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

Per-feature invocation-count limits, keyed by feature name. Independent of features (boolean/value entitlement) — a feature can be entitled and rate-limited at the same time.

---

features?

optional features?: Record<string, unknown> | null

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

---

freeAllowance

freeAllowance: Decimal

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

---

id

id: string

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

---

maxConcurrent?

optional maxConcurrent?: number | null

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

---

name

name: string

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

---

overdraftFloor?

optional overdraftFloor?: Decimal | null

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

---

perOperation?

optional perOperation?: Record<string, OperationPolicy>

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

---

rateOverrides?

optional rateOverrides?: Record<string, string> | null

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