Mayson Monorepo Documentation
    Preparing search index...

    Interface InvoiceListParams

    https://stripe.com/docs/api/pagination

    interface InvoiceListParams {
        collection_method?: Stripe.InvoiceListParams.CollectionMethod;
        created?: number | RangeQueryParam;
        customer?: string;
        customer_account?: string;
        due_date?: number | RangeQueryParam;
        expand?: string[];
        status?: Stripe.InvoiceListParams.Status;
        subscription?: string;
        ending_before?: string;
        limit?: number;
        starting_after?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collection_method? created? customer? customer_account? due_date? expand? status? subscription? ending_before? limit? starting_after?

    Properties

    collection_method?: Stripe.InvoiceListParams.CollectionMethod

    The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.

    created?: number | RangeQueryParam

    Only return invoices that were created during the given date interval.

    customer?: string

    Only return invoices for the customer specified by this customer ID.

    customer_account?: string

    Only return invoices for the account representing the customer specified by this account ID.

    due_date?: number | RangeQueryParam
    expand?: string[]

    Specifies which fields in the response should be expanded.

    status?: Stripe.InvoiceListParams.Status

    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more

    subscription?: string

    Only return invoices for the subscription specified by this subscription ID.

    ending_before?: string

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    limit?: number

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    starting_after?: string

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

    Settings

    Member Visibility

    On This Page

    Properties