Package com.stripe.param

Class SubscriptionItemUpdateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.SubscriptionItemUpdateParams
public class SubscriptionItemUpdateParams extends ApiRequestParams

  • Method Details

    • builder

      public static SubscriptionItemUpdateParams.Builder builder()

    • getBillingThresholds

      public Object getBillingThresholds()
      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.

    • getDiscounts

      public Object getDiscounts()
      The coupons to redeem into discounts for the subscription item.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

    • getMetadata

      public Object getMetadata()
      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.

    • getOffSession

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

    • getPaymentBehavior

      public SubscriptionItemUpdateParams.PaymentBehavior getPaymentBehavior()
      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.

    • getPlan

      public Object getPlan()
      The identifier of the new plan for this subscription item.

    • getPrice

      public Object getPrice()
      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.

    • getPriceData

      public SubscriptionItemUpdateParams.PriceData getPriceData()
      Data used to generate a new Price object inline. One of price or price_data is required.

    • getProrationBehavior

      public SubscriptionItemUpdateParams.ProrationBehavior getProrationBehavior()
      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.

    • getProrationDate

      public Long getProrationDate()
      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.

    • getQuantity

      public Long getQuantity()
      The quantity you'd like to apply to the subscription item you're creating.

    • getTaxRates

      public Object getTaxRates()
      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.