basalt / subscriptions/src / Invoice
Interface: Invoice
Defined in: subscriptions/src/invoice.ts:38
Properties
amountDue
> amountDue: number
Defined in: subscriptions/src/invoice.ts:56
total − amountPaid.
amountPaid
> amountPaid: number
Defined in: subscriptions/src/invoice.ts:54
billableId
> billableId: string
Defined in: subscriptions/src/invoice.ts:42
couponCode?
> optional couponCode?: string
Defined in: subscriptions/src/invoice.ts:68
Coupon applied to this invoice, if any.
createdAt
> createdAt: number
Defined in: subscriptions/src/invoice.ts:59
currency
> currency: string
Defined in: subscriptions/src/invoice.ts:43
discount
> discount: number
Defined in: subscriptions/src/invoice.ts:49
Minor units, ≥ 0, ≤ subtotal.
dueAt?
> optional dueAt?: number
Defined in: subscriptions/src/invoice.ts:61
finalizedAt?
> optional finalizedAt?: number
Defined in: subscriptions/src/invoice.ts:60
gatewayRef?
> optional gatewayRef?: string
Defined in: subscriptions/src/invoice.ts:66
id
> id: string
Defined in: subscriptions/src/invoice.ts:39
lineItems
> lineItems: InvoiceLineItem[]
Defined in: subscriptions/src/invoice.ts:45
metadata?
> optional metadata?: Record<string, unknown>
Defined in: subscriptions/src/invoice.ts:70
notes?
> optional notes?: string
Defined in: subscriptions/src/invoice.ts:69
number
> number: string
Defined in: subscriptions/src/invoice.ts:41
Human number (e.g. INV-2026-0001), assigned on finalize. Empty while draft.
paidAt?
> optional paidAt?: number
Defined in: subscriptions/src/invoice.ts:62
paymentId?
> optional paymentId?: string
Defined in: subscriptions/src/invoice.ts:65
Link to the PaymentRecord.id / gateway reference that settled it.
periodEnd?
> optional periodEnd?: number
Defined in: subscriptions/src/invoice.ts:58
periodStart?
> optional periodStart?: number
Defined in: subscriptions/src/invoice.ts:57
status
> status: InvoiceStatus
Defined in: subscriptions/src/invoice.ts:44
subtotal
> subtotal: number
Defined in: subscriptions/src/invoice.ts:47
Sum of line amounts.
tax
> tax: number
Defined in: subscriptions/src/invoice.ts:51
Minor units, ≥ 0.
total
> total: number
Defined in: subscriptions/src/invoice.ts:53
subtotal − discount + tax.
voidedAt?
> optional voidedAt?: number
Defined in: subscriptions/src/invoice.ts:63