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

    Interface SITerminateSessionResponse

    Confirmation of session termination

    interface SITerminateSessionResponse {
        session_id: string;
        terminated: boolean;
        session_status?: SISessionStatus;
        acp_handoff?: {
            checkout_url?: string;
            checkout_token?: string;
            payload?: {};
            expires_at?: string;
        };
        follow_up?: {
            action?: | "none"
            | "save_for_later"
            | "set_reminder"
            | "subscribe_updates";
            data?: {};
        };
        errors?: Error[];
        ext?: ExtensionObject;
    }
    Index

    Properties

    session_id terminated session_status? acp_handoff? follow_up? errors? ext?

    Properties

    session_id: string

    Terminated session identifier

    terminated: boolean

    Whether session was successfully terminated

    session_status?: SISessionStatus
    acp_handoff?: {
        checkout_url?: string;
        checkout_token?: string;
        payload?: {};
        expires_at?: string;
    }

    ACP checkout handoff data. Present when reason is handoff_transaction.

    Type Declaration

    • Optionalcheckout_url?: string

      Brand's ACP checkout endpoint. Hosts MUST validate this is HTTPS before opening.

    • Optionalcheckout_token?: string

      Opaque token for the checkout flow. The host passes this to the checkout endpoint to correlate the SI session with the transaction.

    • Optionalpayload?: {}

      Rich checkout context to pass to the ACP endpoint (product details, applied offers, pricing). Alternative to checkout_token for integrations that need structured data.

    • Optionalexpires_at?: string

      When this handoff data expires. Hosts should initiate checkout before this time.

    follow_up?: {
        action?:
            | "none"
            | "save_for_later"
            | "set_reminder"
            | "subscribe_updates";
        data?: {};
    }

    Suggested follow-up actions

    Type Declaration

    • Optionalaction?: "none" | "save_for_later" | "set_reminder" | "subscribe_updates"
    • Optionaldata?: {}

      Data for follow-up action

    errors?: Error[]
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties