pub struct ListPlans<'a> {
pub active: Option<bool>,
pub created: Option<RangeQuery<Timestamp>>,
pub ending_before: Option<PlanId>,
pub expand: &'a [&'a str],
pub limit: Option<u64>,
pub product: Option<IdOrCreate<'a, CreateProduct<'a>>>,
pub starting_after: Option<PlanId>,
}
Expand description
The parameters for Plan::list
.
Fields§
§active: Option<bool>
Only return plans that are active or inactive (e.g., pass false
to list all inactive plans).
created: Option<RangeQuery<Timestamp>>
A filter on the list, based on the object created
field.
The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
ending_before: Option<PlanId>
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.
expand: &'a [&'a str]
Specifies which fields in the response should be expanded.
limit: Option<u64>
A limit on the number of objects to be returned.
Limit can range between 1 and 100, and the default is 10.
product: Option<IdOrCreate<'a, CreateProduct<'a>>>
Only return plans for the given product.
starting_after: Option<PlanId>
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.