Create a settlement rule
Create a settlement rule governing how a meter’s gross is split between parties. Rules are created DRAFT by default; pass activateOnCreate: true to go straight to ACTIVE/SCHEDULED. Splits’ shares must sum to exactly 1. Requires scope settlement:write.
Authorizations
API key sent as Authorization: Bearer <api-key>.
Body
Operator-facing label (required, non-empty).
Party splits; shares must sum to exactly "1".
Optional targeting block. If omitted, a targeting block is synthesised from the top-level substrate, appliesToScope, and currency fields.
Convenience — seeds targeting.substrates when targeting is omitted.
Convenience — seeds targeting.appliesToScope when targeting is omitted.
ISO 4217 currency (upper-cased). Defaults to GBP.
Defaults to now. A future value yields SCHEDULED when activated on create.
Author attribution. Defaults to "developer".
When true, create the rule ACTIVE (or SCHEDULED if activeFrom is in the future).