Struct ListSubscription 

pub struct ListSubscription { /* private fields */ }

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

Implementations

impl ListSubscription

pub fn new() -> Self

Construct a new ListSubscription.

pub fn automatic_tax( self, automatic_tax: impl Into<ListSubscriptionAutomaticTax>, ) -> Self

Filter subscriptions by their automatic tax settings.

pub fn collection_method( self, collection_method: impl Into<SubscriptionCollectionMethod>, ) -> Self

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

pub fn created(self, created: impl Into<RangeQueryTs>) -> Self

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

pub fn current_period_end( self, current_period_end: impl Into<RangeQueryTs>, ) -> Self

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

pub fn current_period_start( self, current_period_start: impl Into<RangeQueryTs>, ) -> Self

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

pub fn customer(self, customer: impl Into<String>) -> Self

The ID of the customer whose subscriptions will be retrieved.

pub fn ending_before(self, ending_before: impl Into<String>) -> Self

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.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn limit(self, limit: impl Into<i64>) -> Self

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

pub fn plan(self, plan: impl Into<String>) -> Self

The ID of the plan whose subscriptions will be retrieved.

pub fn price(self, price: impl Into<String>) -> Self

Filter for subscriptions that contain this recurring price ID.

pub fn starting_after(self, starting_after: impl Into<String>) -> Self

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.

pub fn status(self, status: impl Into<ListSubscriptionStatus>) -> Self

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.

pub fn test_clock(self, test_clock: impl Into<String>) -> Self

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.

impl ListSubscription

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

pub fn paginate(&self) -> ListPaginator<List<Subscription>>

Trait Implementations

impl Clone for ListSubscription

fn clone(&self) -> ListSubscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListSubscription

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

Formats the value using the given formatter.

impl Default for ListSubscription

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for ListSubscription

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for ListSubscription

type Output = List<Subscription>

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.