This reference documents every field on a billable item record, including the trigger-specific fields that appear when `bi_billing_type` is set to `trigger`.
Standard Fields (All Billing Types)
string
required
Display name shown on invoices and in the UI
text
optional
Detailed description of the product or service
decimal
required
Base price per unit. For trigger items, this is the default charge amount
string
required
Three-letter currency code
Default: USD
boolean
optional
Whether tax applies to this item
Default:
boolean
optional
Whether bi_unit_price includes tax
Default:
enum
optional
virtual or physical. Trigger items are always virtual
Default: virtual
enum
required
one-off, recurring, or trigger. Determines which additional fields are available
Default: one-off
enum
required
all, credit-card, invoice, or trigger-api
Default: all
boolean
required
Whether the item is active. Inactive items cannot be used in new invoices or enrollments
Default: 1
Trigger-Specific Fields (bi_billing_type = trigger only)
enum
required
fixed, variable, event, or threshold. Determines how amount and condition interact
enum
required
off_session (charge immediately) or client_confirm (send invoice with Pay Now)
Default: off_session
enum
required
lte (<=), gte (>=), or eq (=). Required for fixed, variable, and threshold modes
decimal
required
The Y value in the condition check. Required for fixed, variable, and threshold modes
decimal
optional
Hard minimum for threshold, enforced by platform. Cannot exceed bi_trigger_threshold
boolean
required
If true, fire endpoint accepts override_amount. Required to be true for variable and event modes
Default:
decimal
optional
Upper limit on override_amount. Null means platform default ($500)
string
optional
Human-readable condition description. Auto-generated but editable. Example: When wallet balance <= $15, charge $200