Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Custom Payout/Revenue

Get Custom Payout/Revenue by ID

Retrieve a single custom payout/revenue setting by its ID.

get/networks/custom/payoutrevenue/{settingId}

Path parameters

settingIdinteger required

The custom payout/revenue setting identifier.

Query parameters

relationship'all'

Set to all to include expanded relationship data (ruleset, variables, offer_urls) in the response.

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

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 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
    }
  }
}