Mayson Monorepo Documentation
    Preparing search index...

    Interface PayoutListParams

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

    interface PayoutListParams {
        arrival_date?: number | RangeQueryParam;
        created?: number | RangeQueryParam;
        destination?: string;
        expand?: string[];
        status?: string;
        ending_before?: string;
        limit?: number;
        starting_after?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    arrival_date? created? destination? expand? status? ending_before? limit? starting_after?

    Properties

    arrival_date?: number | RangeQueryParam

    Only return payouts that are expected to arrive during the given date interval.

    created?: number | RangeQueryParam

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

    destination?: string

    The ID of an external account - only return payouts sent to this external account.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    status?: string

    Only return payouts that have the given status: pending, paid, failed, or canceled.

    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