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

    Interface Account

    Account billed for this media buy. Includes advertiser, billing proxy (if any), and rate card applied.

    interface Account {
        account_id: string;
        name: string;
        advertiser?: string;
        billing_proxy?: string;
        status: AccountStatus;
        brand?: BrandReference;
        operator?: string;
        billing?: "operator" | "agent" | "advertiser";
        billing_entity?: BusinessEntity;
        rate_card?: string;
        payment_terms?:
            | "net_15"
            | "net_30"
            | "net_45"
            | "net_60"
            | "net_90"
            | "prepay";
        credit_limit?: { amount: number; currency: string };
        setup?: { url?: string; message: string; expires_at?: string };
        account_scope?: "operator" | "agent" | "brand" | "operator_brand";
        governance_agents?: { url: string; categories?: string[] }[];
        sandbox?: boolean;
        ext?: ExtensionObject;
    }
    Index

    Properties

    account_id: string

    Unique identifier for this account

    name: string

    Human-readable account name (e.g., 'Acme', 'Acme c/o Pinnacle')

    advertiser?: string

    The advertiser whose rates apply to this account

    billing_proxy?: string

    Optional intermediary who receives invoices on behalf of the advertiser (e.g., agency)

    status: AccountStatus
    operator?: string

    Domain of the entity operating this account. When the brand operates directly, this is the brand's domain.

    billing?: "operator" | "agent" | "advertiser"

    Who is invoiced on this account. operator: seller invoices the operator (agency or brand buying direct). agent: agent consolidates billing. advertiser: seller invoices the advertiser directly, even when a different operator places orders on their behalf. See billing_entity for the invoiced party's business details.

    billing_entity?: BusinessEntity
    rate_card?: string

    Identifier for the rate card applied to this account

    payment_terms?: "net_15" | "net_30" | "net_45" | "net_60" | "net_90" | "prepay"

    Payment terms agreed for this account. Binding for all invoices when the account is active.

    credit_limit?: { amount: number; currency: string }

    Maximum outstanding balance allowed

    setup?: { url?: string; message: string; expires_at?: string }

    Present when status is 'pending_approval'. Contains next steps for completing account activation.

    Type Declaration

    • Optionalurl?: string

      URL where the human can complete the required action (credit application, legal agreement, add funds).

    • message: string

      Human-readable description of what's needed.

    • Optionalexpires_at?: string

      When this setup link expires.

    account_scope?: "operator" | "agent" | "brand" | "operator_brand"

    How the seller scoped this account. operator: shared across all brands for this operator. brand: shared across all operators for this brand. operator_brand: dedicated to a specific operator+brand combination. agent: the agent's default account with no brand or operator association.

    governance_agents?: { url: string; categories?: string[] }[]

    Governance agent endpoints registered on this account. Authentication credentials are write-only and not included in responses — use sync_governance to set or update credentials.

    Type Declaration

    • url: string

      Governance agent endpoint URL. Must use HTTPS.

    • Optionalcategories?: string[]

      Governance categories this agent handles (e.g., ['budget_authority', 'strategic_alignment']). When omitted, the agent handles all categories.

    sandbox?: boolean

    When true, this is a sandbox account — no real platform calls, no real spend. For explicit accounts (require_operator_auth: true), sandbox accounts are pre-existing test accounts on the platform discovered via list_accounts. For implicit accounts, sandbox is part of the natural key: the same brand/operator pair can have both a production and sandbox account.

    ext?: ExtensionObject