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.
## Parameters ### `subscription_exposed_id` - Location: path - Required: true - Type: `string` - maxLength: `5000` ## Request body - Required: false ### `application/x-www-form-urlencoded` - Type: `object` ```json {"additionalProperties":false,"properties":{"add_invoice_items":{"description":"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.","items":{"properties":{"price":{"maxLength":5000,"type":"string"},"price_data":{"properties":{"currency":{"type":"string"},"product":{"maxLength":5000,"type":"string"},"tax_behavior":{"enum":["exclusive","inclusive","unspecified"],"type":"string"},"unit_amount":{"type":"integer"},"unit_amount_decimal":{"format":"decimal","type":"string"}},"required":["currency","product"],"title":"one_time_price_data","type":"object"},"quantity":{"type":"integer"},"tax_rates":{"anyOf":[{"items":{"maxLength":5000,"type":"string"},"type":"array"},{"enum":[""],"type":"string"}]}},"title":"add_invoice_item_entry","type":"object"},"type":"array"},"application_fee_percent":{"description":"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](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).","type":"number"},"automatic_tax":{"description":"Automatic tax settings for this subscription.","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"title":"automatic_tax_config","type":"object"},"billing_cycle_anchor":{"description":"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](https://stripe.com/docs/billing/subscriptions/billing-cycle).","enum":["now","unchanged"],"maxLength":5000,"type":"string","x-stripeBypassValidation":true},"billing_thresholds":{"anyOf":[{"properties":{"amount_gte":{"type":"integer"},"reset_billing_cycle_anchor":{"type":"boolean"}},"title":"billing_thresholds_param","type":"object"},{"enum":[""],"type":"string"}],"description":"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":{"anyOf":[{"format":"unix-time","type":"integer"},{"enum":[""],"type":"string"}],"description":"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":{"description":"Boolean indicating whether this subscription should cancel at the end of the current period.","type":"boolean"},"collection_method":{"description":"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`.","enum":["charge_automatically","send_invoice"],"type":"string"},"coupon":{"description":"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.","maxLength":5000,"type":"string"},"days_until_due":{"description":"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`.","type":"integer"},"default_payment_method":{"description":"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](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).","maxLength":5000,"type":"string"},"default_source":{"description":"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](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).","maxLength":5000,"type":"string"},"default_tax_rates":{"anyOf":[{"items":{"maxLength":5000,"type":"string"},"type":"array"},{"enum":[""],"type":"string"}],"description":"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."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"},"type":"array"},"items":{"description":"A list of up to 20 subscription items, each with an attached price.","items":{"properties":{"billing_thresholds":{"anyOf":[{"properties":{"usage_gte":{"type":"integer"}},"required":["usage_gte"],"title":"item_billing_thresholds_param","type":"object"},{"enum":[""],"type":"string"}]},"clear_usage":{"type":"boolean"},"deleted":{"type":"boolean"},"id":{"maxLength":5000,"type":"string"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}]},"price":{"maxLength":5000,"type":"string"},"price_data":{"properties":{"currency":{"type":"string"},"product":{"maxLength":5000,"type":"string"},"recurring":{"properties":{"interval":{"enum":["day","month","week","year"],"type":"string"},"interval_count":{"type":"integer"}},"required":["interval"],"title":"recurring_adhoc","type":"object"},"tax_behavior":{"enum":["exclusive","inclusive","unspecified"],"type":"string"},"unit_amount":{"type":"integer"},"unit_amount_decimal":{"format":"decimal","type":"string"}},"required":["currency","product","recurring"],"title":"recurring_price_data","type":"object"},"quantity":{"type":"integer"},"tax_rates":{"anyOf":[{"items":{"maxLength":5000,"type":"string"},"type":"array"},{"enum":[""],"type":"string"}]}},"title":"subscription_item_update_params","type":"object"},"type":"array"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}],"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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":{"description":"Indicates if a customer is on or off-session while an invoice payment is attempted.","type":"boolean"},"pause_collection":{"anyOf":[{"properties":{"behavior":{"enum":["keep_as_draft","mark_uncollectible","void"],"type":"string"},"resumes_at":{"format":"unix-time","type":"integer"}},"required":["behavior"],"title":"pause_collection_param","type":"object"},{"enum":[""],"type":"string"}],"description":"If specified, payment collection for this subscription will be paused."},"payment_behavior":{"description":"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](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `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](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `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](https://stripe.com/docs/upgrades#2019-03-14) to learn more.","enum":["allow_incomplete","default_incomplete","error_if_incomplete","pending_if_incomplete"],"type":"string"},"payment_settings":{"description":"Payment settings to pass to invoices created by the subscription.","properties":{"payment_method_options":{"properties":{"acss_debit":{"anyOf":[{"properties":{"mandate_options":{"properties":{"transaction_type":{"enum":["business","personal"],"type":"string"}},"title":"mandate_options_param","type":"object"},"verification_method":{"enum":["automatic","instant","microdeposits"],"type":"string","x-stripeBypassValidation":true}},"title":"invoice_payment_method_options_param","type":"object"},{"enum":[""],"type":"string"}]},"bancontact":{"anyOf":[{"properties":{"preferred_language":{"enum":["de","en","fr","nl"],"type":"string"}},"title":"invoice_payment_method_options_param","type":"object"},{"enum":[""],"type":"string"}]},"card":{"anyOf":[{"properties":{"mandate_options":{"properties":{"amount":{"type":"integer"},"amount_type":{"enum":["fixed","maximum"],"type":"string"},"description":{"maxLength":200,"type":"string"}},"title":"mandate_options_param","type":"object"},"request_three_d_secure":{"enum":["any","automatic"],"type":"string"}},"title":"subscription_payment_method_options_param","type":"object"},{"enum":[""],"type":"string"}]}},"title":"payment_method_options","type":"object"},"payment_method_types":{"anyOf":[{"items":{"enum":["ach_credit_transfer","ach_debit","acss_debit","au_becs_debit","bacs_debit","bancontact","boleto","card","fpx","giropay","ideal","sepa_debit","sofort","wechat_pay"],"type":"string","x-stripeBypassValidation":true},"type":"array"},{"enum":[""],"type":"string"}]}},"title":"payment_settings","type":"object"},"pending_invoice_item_interval":{"anyOf":[{"properties":{"interval":{"enum":["day","month","week","year"],"type":"string"},"interval_count":{"type":"integer"}},"required":["interval"],"title":"pending_invoice_item_interval_params","type":"object"},{"enum":[""],"type":"string"}],"description":"Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval."},"promotion_code":{"description":"The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.","maxLength":5000,"type":"string"},"proration_behavior":{"description":"Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.","enum":["always_invoice","create_prorations","none"],"type":"string"},"proration_date":{"description":"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](https://stripe.com/docs/api#retrieve_customer_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.","format":"unix-time","type":"integer"},"transfer_data":{"anyOf":[{"properties":{"amount_percent":{"type":"number"},"destination":{"type":"string"}},"required":["destination"],"title":"transfer_data_specs","type":"object"},{"enum":[""],"type":"string"}],"description":"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":{"anyOf":[{"enum":["now"],"maxLength":5000,"type":"string"},{"format":"unix-time","type":"integer"}],"description":"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":{"description":"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](https://stripe.com/docs/billing/subscriptions/trials) to learn more.","type":"boolean"}},"type":"object"} ``` ## Security ### `basicAuth` - Type: `http` - Request header: `Authorization` - Scheme: `basic` Send credentials in the `Authorization` request header using the `Basic` scheme. Basic HTTP authentication. Allowed headers-- Authorization: Basic