Struct stripe::ListSubscriptions

pub struct ListSubscriptions<'a> {
    pub billing: Option<SubscriptionBilling>,
    pub created: Option<RangeQuery<Timestamp>>,
    pub current_period_end: Option<RangeQuery<Timestamp>>,
    pub current_period_start: Option<RangeQuery<Timestamp>>,
    pub customer: Option<CustomerId>,
    pub ending_before: Option<SubscriptionId>,
    pub expand: &'a [&'a str],
    pub limit: Option<u64>,
    pub plan: Option<PlanId>,
    pub starting_after: Option<SubscriptionId>,
    pub status: Option<SubscriptionStatusFilter>,
}

The parameters for Subscription::list.

Fields

billing: Option<SubscriptionBilling>

The billing mode of the subscriptions to retrieve.

Either charge_automatically or send_invoice.

created: Option<RangeQuery<Timestamp>>

current_period_end: Option<RangeQuery<Timestamp>>

current_period_start: Option<RangeQuery<Timestamp>>

customer: Option<CustomerId>

The ID of the customer whose subscriptions will be retrieved.

ending_before: Option<SubscriptionId>

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.

plan: Option<PlanId>

The ID of the plan whose subscriptions will be retrieved.

starting_after: Option<SubscriptionId>

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.

status: Option<SubscriptionStatusFilter>

The status of the subscriptions to retrieve.

One of: incomplete, incomplete_expired, trialing, active, past_due, unpaid, canceled, or all. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Passing in a value of all will return subscriptions of all statuses.

Methods

impl<'a> ListSubscriptions<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Default for ListSubscriptions<'a>

fn default() -> ListSubscriptions<'a>

Returns the "default value" for a type.

impl<'a> Clone for ListSubscriptions<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ListSubscriptions<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for ListSubscriptions<'a>

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

Serialize this value into the given Serde serializer.