@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface CustomPricing

    Escape hatch for pricing constructs that do not fit cpm, percent_of_media, flat_fee, or per_unit. Use when a vendor prices via performance kickers, tiered volume, hybrid formulas, outcome-sharing, or any other model the standard forms cannot express. Requires a human-readable description and a structured metadata object that captures the parameters a buyer needs to reason about the charge. Buyers SHOULD route custom pricing through operator review before commitment — automatic selection is not recommended.

    interface CustomPricing {
        model: "custom";
        description: string;
        metadata: { summary_for_operator?: string };
        currency?: string;
        ext?: ExtensionObject;
    }
    Index

    Properties

    model: "custom"
    description: string

    Human-readable description of the custom pricing model. Buyers display this to the operator when requesting approval.

    1

    metadata: { summary_for_operator?: string }

    Structured parameters for the custom model. Keys follow lowercase_snake_case. Values may be primitives, arrays, or nested objects. Must be sufficient for a human to understand the pricing basis and for a downstream system to reconstruct the charge. Vendors SHOULD include a summary_for_operator string (one or two sentences, suitable for display in a buyer's operator-review UI) so reviewers across vendors see a consistent prompt. Required operator-review fields (approver role, dollar threshold for automatic approval, escalation contact) MAY be surfaced via additional keys the buyer's review surface recognizes.

    Type Declaration

    • Optionalsummary_for_operator?: string

      One or two sentences describing the pricing construct in plain language, displayed to the buyer's operator when requesting approval. Should not repeat the top-level description verbatim — summarize the charge mechanic instead (e.g., 'Base $12 CPM plus $0.50 per qualifying post-view conversion, capped at $45 CPM').

      1

    currency?: string

    ISO 4217 currency code. Present when the pricing resolves to a monetary charge in a specific currency.

    ^[A-Z]{3}$

    ext?: ExtensionObject