Struct stripe::ListProducts

pub struct ListProducts<'a> {
    pub active: Option<bool>,
    pub created: Option<RangeQuery<Timestamp>>,
    pub ending_before: Option<ProductId>,
    pub expand: &'a [&'a str],
    pub ids: Option<Vec<String>>,
    pub limit: Option<u64>,
    pub shippable: Option<bool>,
    pub starting_after: Option<ProductId>,
    pub type_: Option<ProductType>,
    pub url: Option<&'a str>,
}

The parameters for Product::list.

Fields

active: Option<bool>

Only return products that are active or inactive (e.g., pass false to list all inactive products).

created: Option<RangeQuery<Timestamp>>

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

ending_before: Option<ProductId>

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.

ids: Option<Vec<String>>

Only return products with the given IDs.

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.

shippable: Option<bool>

Only return products that can be shipped (i.e., physical, not digital products).

starting_after: Option<ProductId>

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.

type_: Option<ProductType>

Only return products of this type.

url: Option<&'a str>

Only return products with the given url.

Implementations

impl<'a> ListProducts<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for ListProducts<'a>

fn clone(&self) -> ListProducts<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ListProducts<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a> Default for ListProducts<'a>

fn default() -> ListProducts<'a>

Returns the "default value" for a type.

impl<'a> Serialize for ListProducts<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.