basalt / subscriptions/src / RecurringSubscription
Interface: RecurringSubscription
Defined in: subscriptions/src/recurring.ts:18
Properties
amount
> amount: number
Defined in: subscriptions/src/recurring.ts:23
Price per period, in the currency's minor unit (integer; cents).
billableId
> billableId: string
Defined in: subscriptions/src/recurring.ts:20
The customer/tenant this subscription bills. One per billableId.
createdAt
> createdAt: number
Defined in: subscriptions/src/recurring.ts:32
customer?
> optional customer?: object
Defined in: subscriptions/src/recurring.ts:31
Kept for gateways that need it each period (e.g. phone for Express push).
email?
> optional email?: string
name?
> optional name?: string
phone?
> optional phone?: string
interval
> interval: RecurringInterval
Defined in: subscriptions/src/recurring.ts:24
paidThrough?
> optional paidThrough?: number
Defined in: subscriptions/src/recurring.ts:27
Active until this instant (epoch ms). Undefined before the first payment.
pendingPaymentId?
> optional pendingPaymentId?: string
Defined in: subscriptions/src/recurring.ts:29
The outstanding (unpaid) payment id awaiting confirmation, if any.
plan
> plan: string
Defined in: subscriptions/src/recurring.ts:21
status
> status: RecurringStatus
Defined in: subscriptions/src/recurring.ts:25
updatedAt
> updatedAt: number
Defined in: subscriptions/src/recurring.ts:33