Mayson Monorepo Documentation
    Preparing search index...

    Interface CustomerListParams

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

    interface CustomerListParams {
        created?: number | RangeQueryParam;
        email?: string;
        expand?: string[];
        test_clock?: string;
        ending_before?: string;
        limit?: number;
        starting_after?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    created? email? expand? test_clock? ending_before? limit? starting_after?

    Properties

    created?: number | RangeQueryParam

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

    email?: string

    A case-sensitive filter on the list based on the customer's email field. The value must be a string.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    test_clock?: string

    Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.

    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