Struct stripe::Subscription

pub struct Subscription {
    pub id: String,
    pub application_fee_percent: Option<f64>,
    pub cancel_at_period_end: bool,
    pub canceled_at: Option<Timestamp>,
    pub created: Option<Timestamp>,
    pub current_period_start: Timestamp,
    pub current_period_end: Timestamp,
    pub customer: String,
    pub discount: Option<Discount>,
    pub ended_at: Option<Timestamp>,
    pub items: List<SubscriptionItem>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub plan: Plan,
    pub quantity: u64,
    pub start: Timestamp,
    pub status: String,
    pub tax_percent: Option<f64>,
    pub trial_start: Option<Timestamp>,
    pub trial_end: Option<Timestamp>,
}

The resource representing a Stripe subscription.

For more details see https://stripe.com/docs/api#subscriptions.

Fields

id: String

application_fee_percent: Option<f64>

cancel_at_period_end: bool

canceled_at: Option<Timestamp>

created: Option<Timestamp>

current_period_start: Timestamp

current_period_end: Timestamp

customer: String

discount: Option<Discount>

ended_at: Option<Timestamp>

items: List<SubscriptionItem>

livemode: bool

metadata: Metadata

plan: Plan

quantity: u64

start: Timestamp

status: String

tax_percent: Option<f64>

trial_start: Option<Timestamp>

trial_end: Option<Timestamp>

Methods

impl Subscription

pub fn create(     client: &Client,     params: SubscriptionParams ) -> Result<Subscription, Error>

Creates a new subscription for a customer.

For more details see https://stripe.com/docs/api#create_subscription.

pub fn retrieve(     client: &Client,     subscription_id: &str ) -> Result<Subscription, Error>

Retrieves the details of a subscription.

For more details see https://stripe.com/docs/api#retrieve_subscription.

pub fn update(     client: &Client,     subscription_id: &str,     params: SubscriptionParams ) -> Result<Subscription, Error>

Updates a subscription's properties. For more details see https://stripe.com/docs/api#update_subscription.

pub fn cancel(     client: &Client,     subscription_id: &str,     params: CancelParams ) -> Result<Subscription, Error>

Cancels a subscription.

For more details see https://stripe.com/docs/api#cancel_subscription.

Trait Implementations

impl Debug for Subscription

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

Formats the value using the given formatter.