@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface CPAPricingOption

    Cost Per Acquisition pricing. Advertiser pays a fixed price when a specified conversion event occurs. The event_type field declares which event triggers billing (e.g., purchase, lead, app_install).

    interface CPAPricingOption {
        pricing_option_id: string;
        pricing_model: "cpa";
        event_type: EventType;
        custom_event_name?: string;
        event_source_id?: string;
        currency: string;
        fixed_price: number;
        min_spend_per_package?: number;
        price_breakdown?: PriceBreakdown;
        eligible_adjustments?: PriceAdjustmentKind[];
    }
    Index

    Properties

    pricing_option_id: string

    Unique identifier for this pricing option within the product

    pricing_model: "cpa"

    Cost per acquisition (conversion event)

    event_type: EventType

    The conversion event type that triggers billing (e.g., purchase, lead, app_install)

    custom_event_name?: string

    Name of the custom event when event_type is 'custom'. Required when event_type is 'custom', ignored otherwise.

    event_source_id?: string

    When present, only events from this specific event source count toward billing. Allows different CPA rates for different sources (e.g., online vs in-store purchases). Must match an event source configured via sync_event_sources.

    currency: string

    ISO 4217 currency code

    fixed_price: number

    Fixed price per acquisition in the specified currency

    min_spend_per_package?: number

    Minimum spend requirement per package using this pricing option, in the specified currency

    price_breakdown?: PriceBreakdown
    eligible_adjustments?: PriceAdjustmentKind[]

    Adjustment kinds applicable to this pricing option. Tells buyer agents which adjustments are available before negotiation. When absent, no adjustments are pre-declared — the buyer should check price_breakdown if present.