Struct SubscriptionsList

pub struct SubscriptionsList<'a> { /* private fields */ }

Request builder for fetching subscriptions from Paddle API.

Implementations

impl<'a> SubscriptionsList<'a>

pub fn new(client: &'a Paddle) -> Self

pub fn address_ids( &mut self, address_ids: impl IntoIterator<Item = impl Into<AddressID>>, ) -> &mut Self

Return entities related to the specified addresses.

pub fn after(&mut self, id: impl Into<SubscriptionID>) -> &mut Self

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

pub fn collection_mode(&mut self, mode: CollectionMode) -> &mut Self

Return entities that match the specified collection mode.

pub fn customer_id( &mut self, customer_ids: impl IntoIterator<Item = impl Into<CustomerID>>, ) -> &mut Self

Return entities related to the specified customers.

pub fn id( &mut self, ids: impl IntoIterator<Item = impl Into<SubscriptionID>>, ) -> &mut Self

Return only the IDs specified.

pub fn order_by_asc(&mut self, field: &str) -> &mut Self

Order returned entities by the specified field. Valid fields for ordering: id

pub fn order_by_desc(&mut self, field: &str) -> &mut Self

Order returned entities by the specified field. Valid fields for ordering: id

pub fn per_page(&mut self, entities_per_page: usize) -> &mut Self

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

pub fn price_ids( &mut self, price_ids: impl IntoIterator<Item = impl Into<PriceID>>, ) -> &mut Self

Return entities related to the specified prices.

pub fn scheduled_change_action( &mut self, actions: impl IntoIterator<Item = ScheduledChangeAction>, ) -> &mut Self

Return subscriptions that have a scheduled changes.

pub fn status( &mut self, statuses: impl IntoIterator<Item = SubscriptionStatus>, ) -> &mut Self

Return entities that match the specified subscription statuses.

pub fn send(&self) -> Paginated<'_, Vec<Subscription>>

Returns a paginator for fetching pages of entities from Paddle

Trait Implementations

impl<'a> Serialize for SubscriptionsList<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.