Struct UpdateSubscription 

pub struct UpdateSubscription { /* private fields */ }

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 create preview 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.
• 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. Learn about how Stripe immediately attempts payment for subscription changes.

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.

Implementations

impl UpdateSubscription

pub fn new(subscription_exposed_id: impl Into<SubscriptionId>) -> Self

Construct a new UpdateSubscription.

pub fn add_invoice_items( self, add_invoice_items: impl Into<Vec<UpdateSubscriptionAddInvoiceItems>>, ) -> Self

A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.

pub fn application_fee_percent( self, application_fee_percent: impl Into<f64>, ) -> Self

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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.

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

Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.

pub fn billing_cycle_anchor( self, billing_cycle_anchor: impl Into<UpdateSubscriptionBillingCycleAnchor>, ) -> Self

Either now or unchanged. Setting the value to now resets the subscription’s billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.

pub fn billing_thresholds( self, billing_thresholds: impl Into<BillingThresholdsParam>, ) -> Self

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.

pub fn cancel_at(self, cancel_at: impl Into<UpdateSubscriptionCancelAt>) -> Self

A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period.

pub fn cancel_at_period_end(self, cancel_at_period_end: impl Into<bool>) -> Self

Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false.

pub fn cancellation_details( self, cancellation_details: impl Into<UpdateSubscriptionCancellationDetails>, ) -> Self

Details about why this subscription was cancelled

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

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. Defaults to charge_automatically.

pub fn days_until_due(self, days_until_due: impl Into<u32>) -> Self

Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.

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

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.

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

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.

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

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. Pass an empty string to remove previously-defined tax rates.

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

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.

pub fn discounts(self, discounts: impl Into<Vec<DiscountsDataParam>>) -> Self

The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription’s customer.

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

Specifies which fields in the response should be expanded.

pub fn invoice_settings( self, invoice_settings: impl Into<UpdateSubscriptionInvoiceSettings>, ) -> Self

All invoices will be billed using the specified settings.

pub fn items(self, items: impl Into<Vec<UpdateSubscriptionItems>>) -> Self

A list of up to 20 subscription items, each with an attached price.

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

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

pub fn off_session(self, off_session: impl Into<bool>) -> Self

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).

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

The account on behalf of which to charge, for each of the subscription’s invoices.

pub fn pause_collection( self, pause_collection: impl Into<UpdateSubscriptionPauseCollection>, ) -> Self

If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.

pub fn payment_behavior( self, payment_behavior: impl Into<UpdateSubscriptionPaymentBehavior>, ) -> Self

Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription’s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.

Use default_incomplete to transition the subscription to status=past_due when payment is required and await explicit confirmation of the invoice’s payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.

Use pending_if_incomplete to update the subscription using pending updates. When you use pending_if_incomplete you can only pass the parameters supported by pending updates.

Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription’s invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.

pub fn payment_settings( self, payment_settings: impl Into<UpdateSubscriptionPaymentSettings>, ) -> Self

Payment settings to pass to invoices created by the subscription.

pub fn pending_invoice_item_interval( self, pending_invoice_item_interval: impl Into<UpdateSubscriptionPendingInvoiceItemInterval>, ) -> Self

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.

pub fn proration_behavior( self, proration_behavior: impl Into<UpdateSubscriptionProrationBehavior>, ) -> Self

Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item’s quantity changes. The default value is create_prorations.

pub fn proration_date(self, proration_date: impl Into<Timestamp>) -> Self

If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the create preview endpoint. proration_date can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.

pub fn transfer_data(self, transfer_data: impl Into<TransferDataSpecs>) -> Self

If specified, the funds from the subscription’s invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.

pub fn trial_end(self, trial_end: impl Into<UpdateSubscriptionTrialEnd>) -> Self

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The billing_cycle_anchor will be updated to the trial_end value. The special value now can be provided to end the customer’s trial immediately. Can be at most two years from billing_cycle_anchor.

pub fn trial_from_plan(self, trial_from_plan: impl Into<bool>) -> Self

Indicates if a plan’s trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.

pub fn trial_settings( self, trial_settings: impl Into<UpdateSubscriptionTrialSettings>, ) -> Self

Settings related to subscription trials.

impl UpdateSubscription

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.

Trait Implementations

impl Clone for UpdateSubscription

fn clone(&self) -> UpdateSubscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateSubscription

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

Formats the value using the given formatter.

impl Serialize for UpdateSubscription

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 UpdateSubscription

type Output = 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.