Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Tiered Commissions

Update Tiered Commission

put/networks/tieredcommissions/{commissionId}

Path parameters

commissionIdinteger required

The ID of the tiered commission you want to update.

Request body

namestring required

The name of the tiered commission.

notesstring

Note for internal usage.

status'active' | 'inactive' required

The tiered commissions status. Can either be active or inactive.

start_datestring required

Start of when rule goes into effect. This can be set to a future date.

end_datestring required

End of when rule goes into effect.

period'daily' | 'weekly' | 'monthly' | 'quarterly' | 'global' required

The tiered commissions period. Can either be daily, weekly, monthly, quarterly or global.

network_offer_payout_revenue_idinteger

ID of the offer payout revenue. Defaults to 0.

is_apply_all_affiliatesboolean

Whether or not you want to apply the tiered commission to all affiliates. Defaults to false.

network_affiliate_idsinteger[]

ID of the Affiliates.

network_offer_idsinteger[] required

ID of the offers.

network_advertiser_idsinteger[] nullable

ID of the advertisers.

is_payout_enabledboolean required

Whether or not you want to enable the payout settings. Defaults to false.

payout_action'increase' | 'decrease' | 'flat_increase' | 'flat_decrease' required

Type of payout action. Required only if is_payout_enabled is true. Do not use exact — it will be stored as unknown.

payout_valuenumber required

The payout modifier value. Required only if is_payout_enabled is true. Must be greater than 0.

is_revenue_enabledboolean required

Whether or not you want to enable the revenue. Defaults to false.

revenue_action'increase' | 'decrease' | 'flat_increase' | 'flat_decrease' required

Type of revenue action. Required only if is_revenue_enabled is true. Do not use exact — it will be stored as unknown.

revenue_valuenumber required

The revenue modifier value. Required only if is_revenue_enabled is true. Must be greater than 0.

payout_goalinteger

The payout goal of your tiered commission. Defaults to 0.

revenue_goalinteger

The revenue goal of your tiered commission. Defaults to 0.

sale_amount_goalinteger

The sale amount goal of your tiered commission. Defaults to 0.

conversion_goalinteger

The conversion goal of your tiered commission. Defaults to 0.

event_goalinteger

The event goal of your tiered commission. Defaults to 0.

relationshipobject

Related entities. Pass an empty object {}.

payout_maxinteger

The maximum payout allowed. If set, must be greater than payout_goal. Defaults to 0 (no maximum).

revenue_maxinteger

The maximum revenue allowed. If set, must be greater than revenue_goal. Defaults to 0 (no maximum).

sale_amount_maxinteger

The maximum sale amount allowed. If set, must be greater than sale_amount_goal. Defaults to 0 (no maximum).

conversion_maxinteger

The maximum conversions allowed. If set, must be greater than conversion_goal. Defaults to 0 (no maximum).

event_maxinteger

The maximum events allowed. If set, must be greater than event_goal. Defaults to 0 (no maximum).

is_retroactive_payout_enabledboolean

Whether retroactive payout adjustments are enabled. Defaults to false.

retroactive_payout_action'increase' | 'decrease' | 'flat_increase' | 'flat_decrease' | 'exact'

The retroactive payout action type. Required only if is_retroactive_payout_enabled is true. Supports exact unlike regular payout actions.

retroactive_payout_valuenumber

The retroactive payout modifier value. Required only if is_retroactive_payout_enabled is true. Must be greater than 0.

is_retroactive_revenue_enabledboolean

Whether retroactive revenue adjustments are enabled. Defaults to false.

retroactive_revenue_action'increase' | 'decrease' | 'flat_increase' | 'flat_decrease' | 'exact'

The retroactive revenue action type. Required only if is_retroactive_revenue_enabled is true. Supports exact unlike regular revenue actions.

retroactive_revenue_valuenumber

The retroactive revenue modifier value. Required only if is_retroactive_revenue_enabled is true. Must be greater than 0.

Example request

{
  "name": "SilverCommission",
  "notes": "Monthly payement",
  "status": "active",
  "start_date": "2020-07-23",
  "end_date": "2020-08-22",
  "period": "monthly",
  "network_affiliate_ids": [
    21,
    35,
    28
  ],
  "network_offer_ids": [
    1,
    15,
    12
  ],
  "is_payout_enabled": true,
  "payout_action": "increase",
  "payout_value": 10,
  "is_revenue_enabled": true,
  "revenue_action": "decrease",
  "revenue_value": 6,
  "revenue_goal": 121,
  "conversion_goal": 10,
  "revenue_max": 1000,
  "retroactive_payout_action": "flat_increase",
  "retroactive_payout_value": 5,
  "retroactive_revenue_action": "flat_decrease",
  "retroactive_revenue_value": 5
}

Response

network_tiered_commission_idinteger

Unique tiered commission ID.

network_idinteger

Network ID.

namestring

The name of the tiered commission.

notesstring

Note for internal usage.

status'active' | 'inactive'

The tiered commissions status. Can either be active or inactive.

start_datestring

Start of when rule goes into effect. This can be set to a future date.

end_datestring

End of when rule goes into effect.

period'daily' | 'weekly' | 'monthly' | 'quarterly' | 'global'

The tiered commissions period. Can either be daily, weekly, monthly, quarterly or global.

network_offer_payout_revenue_idinteger

ID of the offer payout revenue.

is_apply_all_affiliatesboolean

Whether or not you want to apply the tiered commission to all affiliates. Defaults to false.

network_affiliate_idsinteger[]

ID of the Affiliates.

network_offer_idsinteger[]

ID of the offers.

network_advertiser_idsinteger[] nullable

ID of the advertisers.

is_payout_enabledboolean

Whether or not you want to enable the payout settings. Defaults to false.

payout_action'increase' | 'decrease' | 'flat_increase' | 'flat_decrease' | 'unknown'

Type of payout action. Note: sending exact will be stored as unknown — use only increase, decrease, flat_increase, or flat_decrease.

payout_valuenumber

The payout modifier value. Required only if is_payout_enabled is true. Must be greater than 0.

is_revenue_enabledboolean

Whether or not you want to enable the revenue. Defaults to false.

revenue_action'increase' | 'decrease' | 'flat_increase' | 'flat_decrease' | 'unknown'

Type of revenue action. Note: sending exact will be stored as unknown — use only increase, decrease, flat_increase, or flat_decrease.

revenue_valuenumber

The revenue modifier value. Required only if is_revenue_enabled is true. Must be greater than 0.

payout_goalinteger

The payout goal of your tiered commission.

revenue_goalinteger

The revenue goal of your tiered commission.

sale_amount_goalinteger

The sale amount goal of your tiered commission.

conversion_goalinteger

The conversion goal of your tiered commission.

event_goalinteger

The event goal of your tiered commission.

relationshipobject

Related entities. Always returns an empty object {} in practice.

payout_maxinteger

The maximum percentage of payout allowed.

revenue_maxinteger

The maximum amount of revenue allowed.

sale_amount_maxinteger

The maximum number of sale amount allowed.

conversion_maxinteger

The maximum number of conversions allowed.

event_maxinteger

The maximum number of events allowed.

is_retroactive_payout_enabledboolean

Whether retroactive payout adjustments are enabled.

retroactive_payout_action'increase' | 'decrease' | 'flat_increase' | 'flat_decrease' | 'exact' | 'unknown'

The retroactive payout action type. Retroactive actions support exact in addition to the standard action types.

retroactive_payout_valuenumber

The retroactive payout modifier value.

retroactive_payout_type'blank' | 'cpc' | 'cpa' | 'cpm' | 'cps' | 'cpa_cps' | 'prv' | 'cpa_sku' | 'cps_sku' | 'cpa_cps_sku' | 'prv_sku'

The retroactive payout type.

retroactive_payout_percentagenumber

The retroactive payout percentage.

is_retroactive_revenue_enabledboolean

Whether retroactive revenue adjustments are enabled.

retroactive_revenue_action'increase' | 'decrease' | 'flat_increase' | 'flat_decrease' | 'exact' | 'unknown'

The retroactive revenue action type. Retroactive actions support exact in addition to the standard action types.

retroactive_revenue_valuenumber

The retroactive revenue modifier value.

retroactive_revenue_type'blank' | 'rpc' | 'rpa' | 'rpm' | 'rps' | 'rpa_rps' | 'rpa_sku' | 'rps_sku' | 'rpa_rps_sku'

The retroactive revenue type.

retroactive_revenue_percentagenumber

The retroactive revenue percentage.

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

Example response

{
  "network_tiered_commission_id": 1,
  "network_id": 1,
  "name": "SilverCommission",
  "notes": "Monthly payement",
  "status": "active",
  "start_date": "2020-07-23",
  "end_date": "2020-08-22",
  "period": "monthly",
  "network_affiliate_ids": [
    21,
    35,
    28
  ],
  "network_offer_ids": [
    1,
    15,
    12
  ],
  "is_payout_enabled": true,
  "payout_action": "increase",
  "payout_value": 10,
  "is_revenue_enabled": true,
  "revenue_action": "decrease",
  "revenue_value": 6,
  "revenue_goal": 121,
  "conversion_goal": 10,
  "revenue_max": 1000,
  "retroactive_payout_action": "flat_increase",
  "retroactive_payout_type": "blank",
  "retroactive_revenue_action": "flat_decrease",
  "retroactive_revenue_type": "blank",
  "time_created": 1734455015,
  "time_saved": 1734455015
}