Update a subscription item 

Updates the plan or quantity of an item on a current subscription.

Parameters

• metadataobject

  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.

• payment_behaviorenum

  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.

  Possible enum values

  allow_incomplete

  default_incomplete

  error_if_incomplete

  pending_if_incomplete

• pricestring

  The ID of the price object. One of price or price_data is required. When changing a subscription item’s price, quantity is set to 1 unless a quantity parameter is provided.

• proration_behaviorenum

  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.

  Possible enum values

  always_invoice Always invoice immediately for prorations.

  create_prorations Will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions.

  none Disable creating prorations in this request.

• quantityinteger

  The quantity you’d like to apply to the subscription item you’re creating.

More parameters

Collapse all

• billing_thresholdsobject

  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.

  Hide child parameters

  • billing_thresholds.usage_gteintegerRequired

    Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)

• discountsarray of objects

  The coupons to redeem into discounts for the subscription item.

  Hide child parameters

  • discounts.couponstring

    ID of the coupon to create a new discount for.

  • discounts.discountstring

    ID of an existing discount on the object (or one of its ancestors) to reuse.

  • discounts.promotion_codestring

    ID of the promotion code to create a new discount for.

• off_sessionboolean

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

• price_dataobject

  Data used to generate a new Price object inline. One of price or price_data is required.

  Hide child parameters

  • price_data.currencyenumRequired

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • price_data.productstringRequired

    The ID of the Product that this Price will belong to.

  • price_data.recurringobjectRequired

    The recurring components of a price such as interval and interval_count.

    Hide child parameters

    • price_data.recurring.intervalenumRequired

      Specifies billing frequency. Either day, week, month or year.

      Possible enum values

      day

      month

      week

      year

    • price_data.recurring.interval_countinteger

      The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

  • price_data.tax_behaviorenumRecommended if calculating taxes

    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

    Possible enum values

    exclusive

    inclusive

    unspecified

  • price_data.unit_amountinteger

    A positive integer in cents (or 0 for a free price) representing how much to charge.

  • price_data.unit_amount_decimalstringRequired conditionally

    Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

• proration_datetimestamp

  If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.

• tax_ratesarray of strings

  A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.