---
title: "Get Custom Payout/Revenue by ID"
method: GET
path: "/networks/custom/payoutrevenue/{settingId}"
tags: ["Custom Payout/Revenue"]
---

# Get Custom Payout/Revenue by ID

`GET /networks/custom/payoutrevenue/{settingId}`

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

## Path parameters

- `settingId` integer, required

## Query parameters

- `relationship` 'all'

## Response `200`

- CustomPayoutRevenue
  - `network_custom_payout_revenue_setting_id` integer — Unique custom payout/revenue setting ID.
  - `network_id` integer — Network ID.
  - `network_offer_id` integer — Associated offer ID.
  - `network_offer_payout_revenue_id` integer — The offer's payout/revenue config ID (0 = base conversion).
  - `name` string — Display name for this custom setting.
  - `custom_setting_status` 'active' | 'inactive' — Setting status.
  - `is_apply_all_affiliates` boolean — Whether this setting applies to all affiliates, including ones who have yet to be created.
  - `is_custom_payout_enabled` boolean — 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_amount` number, double — Custom payout amount. Only relevant for a `payout_type` expressed in absolute values (`cpa`, `cpa_cps`, `cpm`, `cpc`).
  - `payout_percentage` number — Payout percentage. Only relevant for a `payout_type` expressed in percentage (`cps`, `cpa_cps`, `prv`).
  - `is_custom_revenue_enabled` boolean — 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_amount` number, double — Custom revenue amount. Only relevant for a `revenue_type` expressed in absolute values (`rpa`, `rpa_rps`, `rpm`, `rpc`).
  - `revenue_percentage` number — Revenue percentage.
  - `description` string — Internal description.
  - `public_description` string — 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_disabled` boolean — 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_from` string — 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_to` string — 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_urls` boolean — Whether this applies only to specific offer URLs.
  - `network_affiliate_ids` integer[] — Array of affiliate IDs this setting applies to.
  - `time_created` integer — Unix timestamp of creation.
  - `time_saved` integer — Unix timestamp of last update.
  - `network_offer_url_ids` integer[], nullable — Array of offer URL IDs this setting applies to.
  - `relationship` object
    - `affiliates` object — Associated affiliates with pagination.
      - `total` integer — Total number of associated affiliates.
      - `entries` object[]
        - `network_affiliate_id` integer
        - `network_id` integer
        - `name` string
        - `account_status` string
        - `network_employee_id` integer
        - `internal_notes` string
        - `has_notifications` boolean
        - `network_traffic_source_id` integer
        - `account_executive_id` integer
        - `adress_id` integer
        - `default_currency_id` string
        - `is_contact_address_enabled` boolean
        - `enable_media_cost_tracking_links` boolean
        - `time_created` integer
        - `time_saved` integer
        - `referrer_id` integer
    - `offer` object — Associated offer details.
      - `network_offer_id` integer
      - `network_id` integer
      - `network_advertiser_id` integer
      - `network_offer_group_id` integer
      - `name` string
      - `offer_status` string
      - `network_tracking_domain_id` integer
      - `visibility` string
      - `currency_id` string
    - `payout_revenue` object — Associated payout/revenue configuration details.
      - `network_offer_payout_revenue_id` integer
      - `network_id` integer
      - `network_offer_id` integer
      - `entry_name` string
      - `payout_type` string
      - `payout_amount` number, double
      - `payout_percentage` number, double
      - `revenue_type` string
      - `revenue_amount` number, double
      - `revenue_percentage` number, double
      - `is_default` boolean
      - `is_private` boolean
      - `is_postback_disabled` boolean
      - `is_enforce_caps` boolean
      - `time_created` integer
      - `global_advertiser_event_id` integer
      - `is_must_approve_conversion` boolean
      - `is_allow_duplicate_conversion` boolean
      - `is_email_attribution_default_event` boolean
      - `remote_offer_resource` object — Remote offer resource details.
    - `currency_id` string — Currency code for this custom payout/revenue setting.
    - `ruleset` object — Targeting ruleset applied to this setting. Contains geographic, device, browser, and connection targeting rules. See the [Ruleset guide](/user-guide/rulesets) for details.
    - `variables` object — Variable matching rules for this setting.
      - `total` integer — Total number of variables.
      - `entries` object[] — List of variable conditions.
        - `network_custom_payout_revenue_setting_variable_id` integer — Unique variable ID.
        - `network_custom_payout_revenue_setting_id` integer — The parent custom payout/revenue setting ID.
        - `comparison_method` string — How to compare the variable against the value.
        - `variable` string — The parameter name.
        - `variable_value` string — The value to compare against.
        - `variable_secondary_value` string — A secondary value used with range-based comparisons.
    - `offer_urls` object[] — Associated offer URL details (included with `relationship=all` when `is_apply_specific_offer_urls` is `true`).
      - `network_offer_url_id` integer — Unique offer URL ID.
      - `network_id` integer — Network ID.
      - `network_offer_id` integer — Offer ID.
      - `name` string — Offer URL name.

---

[API](https://skmtc.net/everflow/apis/everflow-network-api-tracking-domains.md) · [All operations](https://skmtc.net/everflow/apis/everflow-network-api-tracking-domains/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/everflow/everflow-network-api-tracking-domains/versions/39242cee0e32/schema)
