oc · docs
docs / documentation

@orangecheck/me-client


@orangecheck/me-client / IntegratorEventConfig

Interface: IntegratorEventConfig

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

What an integrator declares for a single event subtype.

Properties

PropertyTypeDescriptionDefined in
<a id="property-agent"></a> agent?AgentClassOverrideOptional per-agent-class pricing override applied when an event fires with is_agent=true.me-client/src/types.ts:111
<a id="property-enabled"></a> enabledbooleanWhether this site bills this event subtype at all.me-client/src/types.ts:102
<a id="property-site_pays"></a> site_paysSiteFeeShapeThe per-event fee the site pays.me-client/src/types.ts:104
<a id="property-user_share_pct"></a> user_share_pctnumberFraction of GROSS that flows to the user (0–0.8 since the platform fee is 20%). The remainder is a rebate to the site's OC project balance.me-client/src/types.ts:108