Struct stripe::UpdateSubscription

pub struct UpdateSubscription<'a> {

    pub add_invoice_items: Option<Vec<AddInvoiceItems>>,
    pub application_fee_percent: Option<f64>,
    pub automatic_tax: Option<UpdateSubscriptionAutomaticTax>,
    pub billing_cycle_anchor: Option<SubscriptionBillingCycleAnchor>,
    pub billing_thresholds: Option<SubscriptionBillingThresholds>,
    pub cancel_at: Option<Timestamp>,
    pub cancel_at_period_end: Option<bool>,
    pub collection_method: Option<CollectionMethod>,
    pub coupon: Option<CouponId>,
    pub days_until_due: Option<u32>,
    pub default_payment_method: Option<&'a str>,
    pub default_source: Option<&'a str>,
    pub default_tax_rates: Option<Vec<String>>,
    pub description: Option<&'a str>,
    pub expand: &'a [&'a str],
    pub items: Option<Vec<UpdateSubscriptionItems>>,
    pub metadata: Option<Metadata>,
    pub off_session: Option<bool>,
    pub pause_collection: Option<UpdateSubscriptionPauseCollection>,
    pub payment_behavior: Option<SubscriptionPaymentBehavior>,
    pub payment_settings: Option<UpdateSubscriptionPaymentSettings>,
    pub pending_invoice_item_interval: Option<UpdateSubscriptionPendingInvoiceItemInterval>,
    pub promotion_code: Option<PromotionCodeId>,
    pub proration_behavior: Option<SubscriptionProrationBehavior>,
    pub proration_date: Option<Timestamp>,
    pub transfer_data: Option<UpdateSubscriptionTransferData>,
    pub trial_end: Option<Scheduled>,
    pub trial_from_plan: Option<bool>,
}

The parameters for Subscription::update.

Fields

add_invoice_items: Option<Vec<AddInvoiceItems>>

A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription.

You may pass up to 20 items.

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

automatic_tax: Option<UpdateSubscriptionAutomaticTax>

Automatic tax settings for this subscription.

We recommend you only include this parameter when the existing value is being changed.

billing_cycle_anchor: Option<SubscriptionBillingCycleAnchor>

Either now or unchanged.

Setting the value to now resets the subscription’s billing cycle anchor to the current time. For more information, see the billing cycle documentation.

billing_thresholds: Option<SubscriptionBillingThresholds>

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

Pass an empty string to remove previously-defined thresholds.

cancel_at: Option<Timestamp>

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.

cancel_at_period_end: Option<bool>

Boolean indicating whether this subscription should cancel at the end of the current period.

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

coupon: Option<CouponId>

The ID of the coupon to apply to this subscription.

A coupon applied to a subscription will only affect invoices created for that particular subscription.

days_until_due: Option<u32>

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.

default_payment_method: Option<&'a str>

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<&'a str>

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<String>>

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.

description: Option<&'a str>

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.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

items: Option<Vec<UpdateSubscriptionItems>>

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

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

off_session: Option<bool>

Indicates if a customer is on or off-session while an invoice payment is attempted.

pause_collection: Option<UpdateSubscriptionPauseCollection>

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

payment_behavior: Option<SubscriptionPaymentBehavior>

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.

payment_settings: Option<UpdateSubscriptionPaymentSettings>

Payment settings to pass to invoices created by the subscription.

pending_invoice_item_interval: Option<UpdateSubscriptionPendingInvoiceItemInterval>

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.

promotion_code: Option<PromotionCodeId>

The promotion code to apply to this subscription.

A promotion code applied to a subscription will only affect invoices created for that particular subscription.

proration_behavior: Option<SubscriptionProrationBehavior>

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.

Valid values are create_prorations, none, or always_invoice. Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass always_invoice. Prorations can be disabled by passing none.

proration_date: Option<Timestamp>

If set, the proration will be calculated as though the subscription was updated at the given time.

This can be used to apply exactly the same proration that was previewed with upcoming invoice endpoint. It 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.

transfer_data: Option<UpdateSubscriptionTransferData>

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.

trial_end: Option<Scheduled>

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 special value now can be provided to end the customer’s trial immediately. Can be at most two years from billing_cycle_anchor.

trial_from_plan: Option<bool>

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.

Implementations

impl<'a> UpdateSubscription<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for UpdateSubscription<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UpdateSubscription<'a>

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

Formats the value using the given formatter.

impl<'a> Default for UpdateSubscription<'a>

fn default() -> UpdateSubscription<'a>

Returns the “default value” for a type.

impl<'a> Serialize for UpdateSubscription<'a>

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

Serialize this value into the given Serde serializer.