Struct Subscription

pub struct Subscription {

    pub id: SubscriptionId,
    pub application: Option<Expandable<Application>>,
    pub application_fee_percent: Option<f64>,
    pub automatic_tax: SubscriptionAutomaticTax,
    pub billing_cycle_anchor: Timestamp,
    pub billing_cycle_anchor_config: Option<SubscriptionsResourceBillingCycleAnchorConfig>,
    pub billing_thresholds: Option<SubscriptionBillingThresholds>,
    pub cancel_at: Option<Timestamp>,
    pub cancel_at_period_end: bool,
    pub canceled_at: Option<Timestamp>,
    pub cancellation_details: Option<CancellationDetails>,
    pub collection_method: Option<CollectionMethod>,
    pub created: Timestamp,
    pub currency: Currency,
    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 description: Option<String>,
    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 next_pending_invoice_item_invoice: Option<Timestamp>,
    pub on_behalf_of: Option<Expandable<Account>>,
    pub pause_collection: Option<SubscriptionsResourcePauseCollection>,
    pub payment_settings: Option<SubscriptionsResourcePaymentSettings>,
    pub pending_invoice_item_interval: Option<SubscriptionPendingInvoiceItemInterval>,
    pub pending_setup_intent: Option<Expandable<SetupIntent>>,
    pub pending_update: Option<SubscriptionsResourcePendingUpdate>,
    pub schedule: Option<Expandable<SubscriptionSchedule>>,
    pub start_date: Timestamp,
    pub status: SubscriptionStatus,
    pub test_clock: Option<Expandable<TestHelpersTestClock>>,
    pub transfer_data: Option<SubscriptionTransferData>,
    pub trial_end: Option<Timestamp>,
    pub trial_settings: Option<SubscriptionsTrialsResourceTrialSettings>,
    pub trial_start: Option<Timestamp>,
}

Available on crate feature billing only.

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: Option<Expandable<Application>>

ID of the Connect Application that created the subscription.

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 total that will be transferred to the application owner’s Stripe account.

automatic_tax: SubscriptionAutomaticTax

billing_cycle_anchor: Timestamp

The reference point that aligns future billing cycle dates.

It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.

billing_cycle_anchor_config: Option<SubscriptionsResourceBillingCycleAnchorConfig>

The fixed values used to calculate the billing_cycle_anchor.

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 reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.

cancellation_details: Option<CancellationDetails>

Details about why this subscription was cancelled.

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 and mark the subscription as active.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

currency: Currency

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

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. This takes precedence over default_source. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or default_source.

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 default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or 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.

description: Option<String>

The subscription’s description, meant to be displayable to the customer.

Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

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 price.

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.

next_pending_invoice_item_invoice: Option<Timestamp>

Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.

on_behalf_of: Option<Expandable<Account>>

The account (if any) the charge was made on behalf of for charges associated with this subscription.

See the Connect documentation for details.

pause_collection: Option<SubscriptionsResourcePauseCollection>

If specified, payment collection for this subscription will be paused.

payment_settings: Option<SubscriptionsResourcePaymentSettings>

Payment settings passed on to invoices created by the subscription.

pending_invoice_item_interval: Option<SubscriptionPendingInvoiceItemInterval>

Specifies an interval for how often to bill for any pending invoice items.

It is analogous to calling Create an invoice for the given subscription at the specified interval.

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.

pending_update: Option<SubscriptionsResourcePendingUpdate>

If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.

schedule: Option<Expandable<SubscriptionSchedule>>

The schedule attached to the subscription.

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 is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings). 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.

test_clock: Option<Expandable<TestHelpersTestClock>>

ID of the test clock this subscription belongs to.

transfer_data: Option<SubscriptionTransferData>

The account (if any) the subscription’s payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription’s invoices.

trial_end: Option<Timestamp>

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

trial_settings: Option<SubscriptionsTrialsResourceTrialSettings>

Settings related to subscription trials.

trial_start: Option<Timestamp>

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

Implementations

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.

Each customer can have up to 500 active or scheduled subscriptions. When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. The payment_behavior parameter determines the exact behavior of the initial payment. To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead. Schedules provide the flexibility to model more complex billing configurations that change over time.

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 to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the upcoming invoice endpoint.

By default, we prorate subscription changes.

For example, if a customer signs up on May 1 for a $100 price, they’ll be billed $100 immediately. If on May 15 they switch to a $200 price, then on June 1 they’ll be billed $250 ($200 for a renewal of her subscription, plus a $50 prorating adjustment for half of the previous month’s $100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes. Switching prices does not normally change the billing date or generate an immediate charge unless:

• The billing interval is changed (for example, from monthly to yearly).
• The subscription moves from free to paid, or paid to free.
• A trial starts or ends.

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer. If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed $100 on May 1 and $200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription. Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

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.

pub fn search( client: &Client, params: SubscriptionSearchParams<'_>, ) -> Response<SearchList<Subscription>>

Searches for a subscription.

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

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 Default for Subscription

fn default() -> Subscription

Returns the “default value” for a type.

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.