v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB

Custom Payout/Revenue

Create Custom Payout/Revenue

post/networks/custom/payoutrevenue

Request body

network_offer_payout_revenue_idinteger required

The offer's payout/revenue configuration ID. Use 0 for the base conversion. For event-level custom payouts, use the specific event ID.

network_offer_idinteger required

The offer ID to create this custom setting for.

namestring required

Display name for this custom payout/revenue setting.

custom_setting_status'active' | 'inactive' required

Setting status.

is_apply_all_affiliatesboolean required

Whether this setting applies to all affiliates, including ones who have yet to be created. If false, you must specify network_affiliate_ids.

network_affiliate_idsinteger[]

Array of affiliate IDs this setting applies to. Required when is_apply_all_affiliates is false.

is_custom_payout_enabledboolean

Whether custom payout is enabled. At least one of is_custom_payout_enabled or is_custom_revenue_enabled must be true.

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

Payout pricing model. Use blank when is_custom_payout_enabled is false. cpc = cost per click, cpa = cost per action, cpm = cost per mille, cps = cost per sale (percentage), cpa_cps = CPA + CPS hybrid, prv = private (hidden from affiliates). The _sku variants are used for Price Per Product offers where SKU variables are specified.

payout_amountnumber double required

Custom payout amount. Only relevant for a payout_type expressed in absolute values (cpa, cpa_cps, cpm, cpc).

payout_percentagenumber required

Payout percentage. Only relevant for a payout_type expressed in percentage (cps, cpa_cps, prv).

is_custom_revenue_enabledboolean

Whether custom revenue is enabled. At least one of is_custom_payout_enabled or is_custom_revenue_enabled must be true.

revenue_type'blank' | 'rpc' | 'rpa' | 'rpm' | 'rps' | 'rpa_rps' | 'rpa_sku' | 'rps_sku' | 'rpa_rps_sku' required

Revenue pricing model. Use blank when is_custom_revenue_enabled is false. rpc = revenue per click, rpa = revenue per action, rpm = revenue per mille, rps = revenue per sale (percentage), rpa_rps = RPA + RPS hybrid. The _sku variants are used for Price Per Product offers where SKU variables are specified.

revenue_amountnumber double required

Custom revenue amount. Only relevant for a revenue_type expressed in absolute values (rpa, rpa_rps, rpm, rpc).

revenue_percentagenumber required

Revenue percentage (used with rps and rpa_rps types).

descriptionstring

Internal description (visible only to network users).

public_descriptionstring

Public description visible to affiliates. Note that if the custom payout revenue completely overrides the base payout revenue settings (not regulated by dates, targeting, or variable rules), it will not appear as a "custom payout" setting for the affiliate, and this description will not be visible.

is_postback_disabledboolean

Whether to disable partner postback firing when this custom setting takes effect. When true, partner postbacks will not fire for conversions matched by this setting.

date_valid_fromstring

Start date for when this setting is active (YYYY-MM-DD). The custom setting will not apply before this date. Leave empty for no start date restriction.

date_valid_tostring

End date for when this setting expires (YYYY-MM-DD). The custom setting will not apply after this date. Leave empty for no end date restriction.

is_apply_specific_offer_urlsboolean

Whether this setting only applies to specific offer URLs.

network_offer_url_idsinteger[]

Array of offer URL IDs this setting applies to. Used when is_apply_specific_offer_urls is true.

rulesetobject

Targeting ruleset for this custom payout/revenue setting. Allows you to restrict when this custom payout/revenue is applied based on geographic, device, browser, and connection criteria. See the Ruleset guide for details.

Response

network_custom_payout_revenue_setting_idinteger

Unique custom payout/revenue setting ID.

network_idinteger

Network ID.

network_offer_idinteger

Associated offer ID.

network_offer_payout_revenue_idinteger

The offer's payout/revenue config ID (0 = base conversion).

namestring

Display name for this custom setting.

custom_setting_status'active' | 'inactive'

Setting status.

is_apply_all_affiliatesboolean

Whether this setting applies to all affiliates, including ones who have yet to be created.

is_custom_payout_enabledboolean

Whether custom payout is enabled.

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

Payout pricing model. blank when custom payout is not enabled.

payout_amountnumber double

Custom payout amount. Only relevant for a payout_type expressed in absolute values (cpa, cpa_cps, cpm, cpc).

payout_percentagenumber

Payout percentage. Only relevant for a payout_type expressed in percentage (cps, cpa_cps, prv).

is_custom_revenue_enabledboolean

Whether custom revenue is enabled.

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

Revenue pricing model. blank when custom revenue is not enabled.

revenue_amountnumber double

Custom revenue amount. Only relevant for a revenue_type expressed in absolute values (rpa, rpa_rps, rpm, rpc).

revenue_percentagenumber

Revenue percentage.

descriptionstring

Internal description.

public_descriptionstring

is_postback_disabledboolean

Whether to disable partner postback firing when this custom setting takes effect. When true, partner postbacks will not fire for conversions matched by this setting.

date_valid_fromstring

Start date for when this setting is active (YYYY-MM-DD). The custom setting will not apply before this date. Leave empty for no start date restriction.

date_valid_tostring

End date for when this setting expires (YYYY-MM-DD). The custom setting will not apply after this date. Leave empty for no end date restriction.

is_apply_specific_offer_urlsboolean

Whether this applies only to specific offer URLs.

network_affiliate_idsinteger[]

Array of affiliate IDs this setting applies to.

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

network_offer_url_idsinteger[] nullable

Array of offer URL IDs this setting applies to.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "affiliates": {
      "entries": [
        {
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    },
    "payout_revenue": {
      "time_created": 1734455015
    }
  }
}