pai
    Preparing search index...

    Type Alias ChildrenResult

    The answer from GET /key/children: the child keys this key made.

    type ChildrenResult = {
        children: {
            active: boolean;
            created_at: string;
            credit_left_usd: number | null;
            credit_spent_usd: number;
            expires_at: string;
            id: string;
            limit_usd: number | null;
            rate_usd_per_min: number | null;
        }[];
        totals: { count: number; credit_spent_usd: number };
    }
    Index
    children totals
    children: {
        active: boolean;
        created_at: string;
        credit_left_usd: number | null;
        credit_spent_usd: number;
        expires_at: string;
        id: string;
        limit_usd: number | null;
        rate_usd_per_min: number | null;
    }[]

    One entry per child, newest first.

    Type Declaration

    • active: boolean

      True while the child is switched on and not past its expiry.

    • created_at: string

      When the child was made, as an ISO 8601 time.

    • credit_left_usd: number | null

      What the child can still spend: the rest of its limit, never more than the parent holds. In USD.

    • credit_spent_usd: number

      What the child has spent, in USD.

    • expires_at: string

      When the child stops working, as an ISO 8601 time.

    • id: string

      The first 12 characters of the child's hash. keyId gives the same id for a key you hold.

    • limit_usd: number | null

      Most the child may spend, in USD. null means no limit beyond the parent's balance.

    • rate_usd_per_min: number | null

      The child's per-minute cap, in USD. null means none.

    totals: { count: number; credit_spent_usd: number }

    Sums over every child.

    Type Declaration

    • count: number

      How many children this key has made.

    • credit_spent_usd: number

      What they have spent together, in USD.

    Settings
    Member Visibility

    On This Page
    Properties