Mayson Monorepo Documentation
    Preparing search index...

    Interface ReaderListParams

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

    interface ReaderListParams {
        device_type?: Stripe.Terminal.ReaderListParams.DeviceType;
        expand?: string[];
        location?: string;
        serial_number?: string;
        status?: Stripe.Terminal.ReaderListParams.Status;
        ending_before?: string;
        limit?: number;
        starting_after?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    device_type? expand? location? serial_number? status? ending_before? limit? starting_after?

    Properties

    device_type?: Stripe.Terminal.ReaderListParams.DeviceType

    Filters readers by device type

    expand?: string[]

    Specifies which fields in the response should be expanded.

    location?: string

    A location ID to filter the response list to only readers at the specific location

    serial_number?: string

    Filters readers by serial number

    status?: Stripe.Terminal.ReaderListParams.Status

    A status filter to filter readers to only offline or online readers

    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