oc · docs
docs / documentation

@orangecheck/me-client


@orangecheck/me-client / BillableEvent

Interface: BillableEvent

Defined in: me-client/src/types.ts:248

Extended by

Properties

PropertyTypeDescriptionDefined in
<a id="property-class"></a> classEventClass-me-client/src/types.ts:251
<a id="property-drop"></a> drop?| &#123; close_height_target: number | null; window_id: string; &#125; | nullDrop-period stamp · present when the project covers this subtype with a drop schedule. The user-share of a stamped event MATURES until the window's boundary, then vests as one batch (the drop). Billing is untouched. Part of the SIGNED canonical bytes (encoder branches to v=4 when present). No clawback exists — vesting is unconditional, and an open window's boundary can only ever move earlier.me-client/src/types.ts:273
<a id="property-gross_fee_sats"></a> gross_fee_satsnumber-me-client/src/types.ts:254
<a id="property-id"></a> idstring-me-client/src/types.ts:249
<a id="property-is_agent"></a> is_agent?booleanPer OCHK-V3-PLAN §7 phase-1 · true when the event was fired by an oc-agent delegation rather than a human session. The integrator's IntegratorEventConfig.agent block may price these differently or refuse them. Optional · canonical encoder branches to v=3 only when present, so legacy human-fired events keep their v=2 hash + signature.me-client/src/types.ts:265
<a id="property-occurred_at"></a> occurred_atstring-me-client/src/types.ts:250
<a id="property-platform_fee_sats"></a> platform_fee_satsnumber-me-client/src/types.ts:255
<a id="property-site"></a> site&#123; display_name: string; domain: string; &#125;-me-client/src/types.ts:253
site.display_namestring-me-client/src/types.ts:253
site.domainstring-me-client/src/types.ts:253
<a id="property-site_rebate_sats"></a> site_rebate_satsnumber-me-client/src/types.ts:257
<a id="property-subtype"></a> subtypeEventSubtype-me-client/src/types.ts:252
<a id="property-user_earned_sats"></a> user_earned_satsnumber-me-client/src/types.ts:256
<a id="property-verify_url"></a> verify_urlstring-me-client/src/types.ts:258