Struct ListProductsParams 

pub struct ListProductsParams {
    pub id: Option<Vec<Uuid>>,
    pub organization_id: Option<Vec<Uuid>>,
    pub query: Option<String>,
    pub is_archived: Option<bool>,
    pub is_recurring: Option<bool>,
    pub benefit_id: Option<Vec<Uuid>>,
    pub page: Option<usize>,
    pub limit: Option<u8>,
    pub sorting: Option<Vec<ProductsSorting>>,
    pub metadata: Option<HashMap<String, String>>,
}

Fields

id: Option<Vec<Uuid>>

Filter by product ID.

organization_id: Option<Vec<Uuid>>

Filter by organization ID.

query: Option<String>

Filter by product name.

is_archived: Option<bool>

Filter on archived products.

is_recurring: Option<bool>

Filter on recurring products. If true, only subscriptions tiers are returned. If false, only one-time purchase products are returned.

benefit_id: Option<Vec<Uuid>>

Filter products granting specific benefit.

page: Option<usize>

Page number, defaults to 1.

Required range: x > 0

limit: Option<u8>

Size of a page, defaults to 10. Maximum is 100.

Required range: x > 0

sorting: Option<Vec<ProductsSorting>>

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

metadata: Option<HashMap<String, String>>

Filter by metadata key-value pairs.

Trait Implementations

impl Default for ListProductsParams

fn default() -> ListProductsParams

Returns the “default value” for a type.

impl Serialize for ListProductsParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.