Skip to main content
PATCH
Update commission plan (PATCH)

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Path Parameters

id
integer
required

Commission plan ID.

Body

application/json
title
string
status
integer

Commission plan status to set: 1=active, 2=paused, 3=inactive. 4=deleted is a stored value only - it is set by DELETE /api/v2/network/commission-plan/{id}, and sending it here is rejected with 422 (CommissionPlanForm validates against CommissionPlanListHelper::getStatuses(), which lists 1/2/3). Note the deleted code is 4 here, unlike the 5 used by offers, affiliates and advertisers.

product
integer
currency
string | null

Currency code. Only accepted when native_currency_commissions is ON. Null or omitted = Brand Currency.

assigned_to
integer[]

Affiliate IDs. Deleted affiliates are ignored during validation and are removed from existing assignments on update.

flat_fee
object

Fixed recurring or one-time fee. Past dates are accepted for commission.start_date.

cpa
object
rev_share
object

Response

Commission plan updated.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string