Mayson Monorepo Documentation
    Preparing search index...

    Interface SubscriptionListParams

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

    interface SubscriptionListParams {
        automatic_tax?: Stripe.SubscriptionListParams.AutomaticTax;
        collection_method?: Stripe.SubscriptionListParams.CollectionMethod;
        created?: number | RangeQueryParam;
        current_period_end?: number | RangeQueryParam;
        current_period_start?: number | RangeQueryParam;
        customer?: string;
        customer_account?: string;
        expand?: string[];
        plan?: string;
        price?: string;
        status?: Stripe.SubscriptionListParams.Status;
        test_clock?: string;
        ending_before?: string;
        limit?: number;
        starting_after?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    automatic_tax? collection_method? created? current_period_end? current_period_start? customer? customer_account? expand? plan? price? status? test_clock? ending_before? limit? starting_after?

    Properties

    automatic_tax?: Stripe.SubscriptionListParams.AutomaticTax

    Filter subscriptions by their automatic tax settings.

    collection_method?: Stripe.SubscriptionListParams.CollectionMethod

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

    created?: number | RangeQueryParam

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

    current_period_end?: number | RangeQueryParam

    Only return subscriptions whose minimum item current_period_end falls within the given date interval.

    current_period_start?: number | RangeQueryParam

    Only return subscriptions whose maximum item current_period_start falls within the given date interval.

    customer?: string

    The ID of the customer whose subscriptions you're retrieving.

    customer_account?: string

    The ID of the account representing the customer whose subscriptions you're retrieving.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    plan?: string

    The ID of the plan whose subscriptions will be retrieved.

    price?: string

    Filter for subscriptions that contain this recurring price ID.

    status?: Stripe.SubscriptionListParams.Status

    The status of the subscriptions to retrieve. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Pass ended to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value of all will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.

    test_clock?: string

    Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer 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