basalt / subscriptions/src / SubscriptionRecord

Interface: SubscriptionRecord

Defined in: subscriptions/src/stores.ts:33

Properties

billableId

> billableId: string

Defined in: subscriptions/src/stores.ts:35

The billable entity — the tenant id by convention.

---

cancelAtPeriodEnd?

> optional cancelAtPeriodEnd?: boolean

Defined in: subscriptions/src/stores.ts:40

---

canceledAt?

> optional canceledAt?: number

Defined in: subscriptions/src/stores.ts:41

---

gatewayRef?

> optional gatewayRef?: string

Defined in: subscriptions/src/stores.ts:43

Reference in the payment gateway (e.g. Stripe subscription id).

---

pendingPeriod?

> optional pendingPeriod?: BillingPeriod

Defined in: subscriptions/src/stores.ts:52

---

pendingPlan?

> optional pendingPlan?: string

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

Plan intent of an in-flight hosted Checkout (set by checkout() when a subscription already exists). Promoted to plan ONLY when the gateway confirms payment with a NEW gatewayRef — a renewal of the current subscription can never activate it. This is the fail-closed guard against plan escalation via an abandoned checkout.

---

period

> period: BillingPeriod

Defined in: subscriptions/src/stores.ts:37

---

plan

> plan: string

Defined in: subscriptions/src/stores.ts:36

---

status

> status: SubscriptionStatus

Defined in: subscriptions/src/stores.ts:38

---

trialEndsAt?

> optional trialEndsAt?: number

Defined in: subscriptions/src/stores.ts:39