Mayson Monorepo Documentation
    Preparing search index...

    Interface VerificationSessionListParams

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

    interface VerificationSessionListParams {
        client_reference_id?: string;
        created?: number | RangeQueryParam;
        expand?: string[];
        related_customer?: string;
        related_customer_account?: string;
        status?: Stripe.Identity.VerificationSessionListParams.Status;
        ending_before?: string;
        limit?: number;
        starting_after?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    client_reference_id? created? expand? related_customer? related_customer_account? status? ending_before? limit? starting_after?

    Properties

    client_reference_id?: string

    A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.

    created?: number | RangeQueryParam

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

    expand?: string[]

    Specifies which fields in the response should be expanded.

    related_customer?: string

    Customer ID

    related_customer_account?: string

    The ID of the Account representing a customer.

    status?: Stripe.Identity.VerificationSessionListParams.Status

    Only return VerificationSessions with this status. Learn more about the lifecycle of sessions.

    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