@shieldz/sdk
    Preparing search index...

    Interface Invoice

    interface Invoice {
        amount_usd_cents: number;
        created_at: number;
        customer_email: string | null;
        expires_at: number;
        id: string;
        idempotent_replay?: boolean;
        memo: string | null;
        metadata: unknown;
        mode: Mode;
        object: "invoice";
        paid_after_expiry: boolean;
        paid_at: number | null;
        paid_on:
            | {
                asset_symbol: string
                | null;
                chain_id: string;
                tx_hash: string | null;
            }
            | null;
        pay_url: string;
        payment_address: string
        | null;
        payment_amount_atomic: string | null;
        payment_chain_id: string | null;
        payment_targets: PaymentTarget[];
        settlement: Settlement;
        status: InvoiceStatus;
        submitted_tx_hash: string | null;
        zcash:
            | {
                amount_zec_atomic: string;
                u1_address: string;
                zec_usd_rate_at_creation: number
                | null;
            }
            | null;
    }
    Index

    Properties

    amount_usd_cents created_at customer_email expires_at id idempotent_replay? memo metadata mode object paid_after_expiry paid_at paid_on pay_url payment_address payment_amount_atomic payment_chain_id payment_targets settlement status submitted_tx_hash zcash

    Properties

    amount_usd_cents: number
    created_at: number

    Unix milliseconds.

    customer_email: string | null
    expires_at: number

    Unix milliseconds.

    id: string

    Unguessable public id; also the path segment in pay_url.

    idempotent_replay?: boolean

    Present and true when an idempotency_key replay returned the original invoice.

    memo: string | null
    metadata: unknown
    mode: Mode
    object: "invoice"
    paid_after_expiry: boolean
    paid_at: number | null

    Unix milliseconds; null until paid.

    paid_on:
        | {
            asset_symbol: string
            | null;
            chain_id: string;
            tx_hash: string | null;
        }
        | null
    pay_url: string

    The hosted checkout URL to send your customer to.

    payment_address: string | null
    payment_amount_atomic: string | null
    payment_chain_id: string | null

    Legacy single-chain fields (kept for backward compatibility).

    payment_targets: PaymentTarget[]
    settlement: Settlement
    status: InvoiceStatus
    submitted_tx_hash: string | null
    zcash:
        | {
            amount_zec_atomic: string;
            u1_address: string;
            zec_usd_rate_at_creation: number
            | null;
        }
        | null

    Settings

    Member Visibility

    On This Page

    Properties