Pennylane API Client
    Preparing search index...

    Interface GetCustomerInvoicesQueryParams

    Query parameters for listing customer invoices.

    Supports the v2026 pagination system and query options.

    interface GetCustomerInvoicesQueryParams {
        cursor?: string;
        filter?: readonly CustomerInvoiceFilter[];
        include?: string;
        limit?: number;
        sort?: string;
    }

    Hierarchy

    • CursorPaginationQueryParams
      • GetCustomerInvoicesQueryParams
    Index

    Properties

    cursor? filter? include? limit? sort?

    Properties

    cursor?: string

    Cursor for pagination. Use this to fetch the next set of results.

    filter?: readonly CustomerInvoiceFilter[]

    Filter customer invoices by specific fields. API format: JSON array serialized into a query string.

    include?: string

    Include additional related resources in the response. Currently supports: invoice_lines

    Warning: This feature is experimental and may change in future releases.

    limit?: number

    Number of items to return per request (between 1 and 100).

    sort?: string

    Sort customer invoices by attributes. Prefix with - for descending order. Default: -id

    Settings

    Member Visibility

    On This Page

    Properties