HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner contract / Settlement override / Create

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Create a settlement override for a specific partner contract.

Available only when settlement overrides are enabled for the operator owning the partner
contract; otherwise the request is rejected with 412 and errorCode
settlement_overrides_not_enabled. When the payload is valid but another active override on
the contract already uses the requested priority, the request is rejected with 409 and
errorCode override_priority_taken. Every other rejection is an ordinary 422 listing the
offending properties in the errors map and carrying no errorCode — including a name
already used by another active override, and including the priority conflict when the payload
fails other rules as well.

Required permission: PartnerContracts.create

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Partner contract ID

Body Params

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Settlement override create schema. Every property that is omitted takes its documented default; acPercent and dcPercent cannot both be omitted.

string
required
length ≤ 255

Name of the settlement override, unique among the active overrides of the partner contract.

integer
required
1 to 4294967295

Evaluation priority of the override, unique among the active overrides of the partner contract.
The lowest value that matches a session wins.

restriction
object
required

Which users of the partner contract the override applies to. type is the discriminator and
determines what targetIds references.

float
0 to 100

Partner share percentage applied to AC sessions matched by this override.
Omit to inherit the value from the partner contract. At least one of acPercent
and dcPercent must be provided.

float
0 to 100

Partner share percentage applied to DC sessions matched by this override.
Omit to inherit the value from the partner contract. At least one of acPercent
and dcPercent must be provided.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json