Skip to main content
GET
Get Tiered Commission

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Path Parameters

commissionId
integer
required

The ID of the tiered commission you want to fetch.

Response

A tiered commission configuration with all computed and relational fields.

network_tiered_commission_id
integer

Unique tiered commission ID.

Example:

1

network_id
integer

Network ID.

Example:

1

name
string

The name of the tiered commission.

Example:

"SilverCommission"

notes
string

Note for internal usage.

Example:

"Monthly payement"

status
enum<string>

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

Available options:
active,
inactive
Example:

"active"

start_date
string

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

Example:

"2020-07-23"

end_date
string

End of when rule goes into effect.

Example:

"2020-08-22"

period
enum<string>

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

Available options:
daily,
weekly,
monthly,
quarterly,
global
Example:

"monthly"

network_offer_payout_revenue_id
integer

ID of the offer payout revenue.

Example:

0

is_apply_all_affiliates
boolean

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

Example:

false

network_affiliate_ids
integer[]

ID of the Affiliates.

Example:
network_offer_ids
integer[]

ID of the offers.

Example:
network_advertiser_ids
integer[] | null

ID of the advertisers.

Example:

null

is_payout_enabled
boolean

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

Example:

true

payout_action
enum<string>

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

Available options:
increase,
decrease,
flat_increase,
flat_decrease,
unknown
Example:

"increase"

payout_value
number

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

Example:

10

is_revenue_enabled
boolean

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

Example:

true

revenue_action
enum<string>

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

Available options:
increase,
decrease,
flat_increase,
flat_decrease,
unknown
Example:

"decrease"

revenue_value
number

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

Example:

6

payout_goal
integer

The payout goal of your tiered commission.

Example:

0

revenue_goal
integer

The revenue goal of your tiered commission.

Example:

121

sale_amount_goal
integer

The sale amount goal of your tiered commission.

Example:

0

conversion_goal
integer

The conversion goal of your tiered commission.

Example:

10

event_goal
integer

The event goal of your tiered commission.

Example:

0

relationship
object

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

payout_max
integer

The maximum percentage of payout allowed.

Example:

0

revenue_max
integer

The maximum amount of revenue allowed.

Example:

1000

sale_amount_max
integer

The maximum number of sale amount allowed.

Example:

0

conversion_max
integer

The maximum number of conversions allowed.

Example:

0

event_max
integer

The maximum number of events allowed.

Example:

0

is_retroactive_payout_enabled
boolean

Whether retroactive payout adjustments are enabled.

Example:

false

retroactive_payout_action
enum<string>

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

Available options:
increase,
decrease,
flat_increase,
flat_decrease,
exact,
unknown
Example:

"flat_increase"

retroactive_payout_value
number

The retroactive payout modifier value.

Example:

0

retroactive_payout_type
enum<string>

The retroactive payout type.

Available options:
blank,
cpc,
cpa,
cpm,
cps,
cpa_cps,
prv,
cpa_sku,
cps_sku,
cpa_cps_sku,
prv_sku
Example:

"blank"

retroactive_payout_percentage
number

The retroactive payout percentage.

Example:

0

is_retroactive_revenue_enabled
boolean

Whether retroactive revenue adjustments are enabled.

Example:

false

retroactive_revenue_action
enum<string>

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

Available options:
increase,
decrease,
flat_increase,
flat_decrease,
exact,
unknown
Example:

"flat_decrease"

retroactive_revenue_value
number

The retroactive revenue modifier value.

Example:

0

retroactive_revenue_type
enum<string>

The retroactive revenue type.

Available options:
blank,
rpc,
rpa,
rpm,
rps,
rpa_rps,
rpa_sku,
rps_sku,
rpa_rps_sku
Example:

"blank"

retroactive_revenue_percentage
number

The retroactive revenue percentage.

Example:

0

time_created
integer

Unix timestamp of creation.

Example:

1734455015

time_saved
integer

Unix timestamp of last update.

Example:

1734455015