Struct stripe::Subscription

pub struct Subscription {
    pub id: SubscriptionId,
    pub application_fee_percent: Option<f64>,
    pub billing: Option<CollectionMethod>,
    pub billing_cycle_anchor: Timestamp,
    pub billing_thresholds: Option<SubscriptionBillingThresholds>,
    pub cancel_at: Option<Timestamp>,
    pub cancel_at_period_end: bool,
    pub canceled_at: Option<Timestamp>,
    pub collection_method: Option<CollectionMethod>,
    pub created: Timestamp,
    pub current_period_end: Timestamp,
    pub current_period_start: Timestamp,
    pub customer: Expandable<Customer>,
    pub days_until_due: Option<u32>,
    pub default_payment_method: Option<Expandable<PaymentMethod>>,
    pub default_source: Option<Expandable<PaymentSource>>,
    pub default_tax_rates: Option<Vec<TaxRate>>,
    pub discount: Option<Discount>,
    pub ended_at: Option<Timestamp>,
    pub items: List<SubscriptionItem>,
    pub latest_invoice: Option<Expandable<Invoice>>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub pending_setup_intent: Option<Expandable<SetupIntent>>,
    pub plan: Option<Plan>,
    pub quantity: Option<u64>,
    pub schedule: Option<Expandable<SubscriptionSchedule>>,
    pub start: Timestamp,
    pub start_date: Timestamp,
    pub status: SubscriptionStatus,
    pub tax_percent: Option<f64>,
    pub trial_end: Option<Timestamp>,
    pub trial_start: Option<Timestamp>,
}

The resource representing a Stripe "Subscription".

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

Fields

id: SubscriptionId

Unique identifier for the object.

application_fee_percent: Option<f64>

A non-negative decimal between 0 and 100, with at most two decimal places.

This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.

billing: Option<CollectionMethod>

This field has been renamed to collection_method and will be removed in a future API version.

billing_cycle_anchor: Timestamp

Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.

billing_thresholds: Option<SubscriptionBillingThresholds>

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

cancel_at: Option<Timestamp>

A date in the future at which the subscription will automatically get canceled.

cancel_at_period_end: bool

If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true.

You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.

canceled_at: Option<Timestamp>

If the subscription has been canceled, the date of that cancellation.

If the subscription was canceled with cancel_at_period_end, canceled_at will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.

collection_method: Option<CollectionMethod>

Either charge_automatically, or send_invoice.

When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

current_period_end: Timestamp

End of the current period that the subscription has been invoiced for.

At the end of this period, a new invoice will be created.

current_period_start: Timestamp

Start of the current period that the subscription has been invoiced for.

customer: Expandable<Customer>

ID of the customer who owns the subscription.

days_until_due: Option<u32>

Number of days a customer has to pay invoices generated by this subscription.

This value will be null for subscriptions where collection_method=charge_automatically.

default_payment_method: Option<Expandable<PaymentMethod>>

ID of the default payment method for the subscription.

It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings.

default_source: Option<Expandable<PaymentSource>>

ID of the default payment source for the subscription.

It must belong to the customer associated with the subscription and be in a chargeable state. If not set, defaults to the customer's default source.

default_tax_rates: Option<Vec<TaxRate>>

The tax rates that will apply to any subscription item that does not have tax_rates set.

Invoices created will have their default_tax_rates populated from the subscription.

discount: Option<Discount>

Describes the current discount applied to this subscription, if there is one.

When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.

ended_at: Option<Timestamp>

If the subscription has ended, the date the subscription ended.

items: List<SubscriptionItem>

List of subscription items, each with an attached plan.

latest_invoice: Option<Expandable<Invoice>>

The most recent invoice this subscription has generated.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: Metadata

Set of key-value pairs that you can attach to an object.

This can be useful for storing additional information about the object in a structured format.

pending_setup_intent: Option<Expandable<SetupIntent>>

You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments.

Learn more in the SCA Migration Guide.

plan: Option<Plan>

Hash describing the plan the customer is subscribed to.

Only set if the subscription contains a single plan.

quantity: Option<u64>

The quantity of the plan to which the customer is subscribed.

For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly. Only set if the subscription contains a single plan.

schedule: Option<Expandable<SubscriptionSchedule>>

The schedule attached to the subscription.

start: Timestamp

Date of the last substantial change to this subscription.

For example, a change to the items array, or a change of status, will reset this timestamp.

start_date: Timestamp

Date when the subscription was first created.

The date might differ from the created date due to backdating.

status: SubscriptionStatus

Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.

For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active state. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal state, the open invoice will be voided and no further invoices will be generated. A subscription that is currently in a trial period is trialing and moves to active when the trial period is over. If subscription collection_method=charge_automatically it becomes past_due when payment to renew it fails and canceled or unpaid (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts. If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

tax_percent: Option<f64>

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

trial_end: Option<Timestamp>

If the subscription has a trial, the end of that trial.

trial_start: Option<Timestamp>

If the subscription has a trial, the beginning of that trial.

Methods

impl Subscription

pub fn list(
    client: &Client,
    params: ListSubscriptions
) -> Response<List<Subscription>>

By default, returns a list of subscriptions that have not been canceled.

In order to list canceled subscriptions, specify status=canceled.

pub fn create(
    client: &Client,
    params: CreateSubscription
) -> Response<Subscription>

Creates a new subscription on an existing customer.

pub fn retrieve(
    client: &Client,
    id: &SubscriptionId,
    expand: &[&str]
) -> Response<Subscription>

Retrieves the subscription with the given ID.

pub fn update(
    client: &Client,
    id: &SubscriptionId,
    params: UpdateSubscription
) -> Response<Subscription>

Updates an existing subscription on a customer to match the specified parameters.

When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

pub fn delete(
    client: &Client,
    id: &SubscriptionId
) -> Response<Deleted<SubscriptionId>>

Cancels a customer’s subscription immediately.

The customer will not be charged again for the subscription. Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed. By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

impl Subscription

pub fn cancel(
    client: &Client,
    subscription_id: &SubscriptionId,
    params: CancelSubscription
) -> Response<Subscription>

Cancels a subscription.

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

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Subscription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Object for Subscription

type Id = SubscriptionId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Serialize for Subscription

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

Serialize this value into the given Serde serializer.