Package com.stripe.param

Class SubscriptionItemUpdateParams.Builder

java.lang.Object
com.stripe.param.SubscriptionItemUpdateParams.Builder
Enclosing class:
SubscriptionItemUpdateParams
public static class SubscriptionItemUpdateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public SubscriptionItemUpdateParams build()
      Finalize and obtain parameter instance from this builder.

    • setBillingThresholds

      public SubscriptionItemUpdateParams.Builder setBillingThresholds(SubscriptionItemUpdateParams.BillingThresholds billingThresholds)
      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.

    • setBillingThresholds

      public SubscriptionItemUpdateParams.Builder setBillingThresholds(EmptyParam billingThresholds)
      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.

    • addDiscount

      public SubscriptionItemUpdateParams.Builder addDiscount(SubscriptionItemUpdateParams.Discount element)
      Add an element to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionItemUpdateParams.discounts for the field documentation.

    • addAllDiscount

      public SubscriptionItemUpdateParams.Builder addAllDiscount(List<SubscriptionItemUpdateParams.Discount> elements)
      Add all elements to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionItemUpdateParams.discounts for the field documentation.

    • setDiscounts

      public SubscriptionItemUpdateParams.Builder setDiscounts(EmptyParam discounts)
      The coupons to redeem into discounts for the subscription item.

    • setDiscounts

      public SubscriptionItemUpdateParams.Builder setDiscounts(List<SubscriptionItemUpdateParams.Discount> discounts)
      The coupons to redeem into discounts for the subscription item.

    • addExpand

      public SubscriptionItemUpdateParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionItemUpdateParams.expand for the field documentation.

    • addAllExpand

      public SubscriptionItemUpdateParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionItemUpdateParams.expand for the field documentation.

    • putExtraParam

      public SubscriptionItemUpdateParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionItemUpdateParams.extraParams for the field documentation.

    • putAllExtraParam

      public SubscriptionItemUpdateParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionItemUpdateParams.extraParams for the field documentation.

    • putMetadata

      public SubscriptionItemUpdateParams.Builder putMetadata(String key, String value)
      Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionItemUpdateParams.metadata for the field documentation.

    • putAllMetadata

      public SubscriptionItemUpdateParams.Builder putAllMetadata(Map<String,String> map)
      Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionItemUpdateParams.metadata for the field documentation.

    • setMetadata

      public SubscriptionItemUpdateParams.Builder setMetadata(EmptyParam 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.

    • setMetadata

      public SubscriptionItemUpdateParams.Builder setMetadata(Map<String,String> 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.

    • setOffSession

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

    • setPaymentBehavior

      public SubscriptionItemUpdateParams.Builder setPaymentBehavior(SubscriptionItemUpdateParams.PaymentBehavior paymentBehavior)
      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.

    • setPlan

      public SubscriptionItemUpdateParams.Builder setPlan(String plan)
      The identifier of the new plan for this subscription item.

    • setPlan

      public SubscriptionItemUpdateParams.Builder setPlan(EmptyParam plan)
      The identifier of the new plan for this subscription item.

    • setPrice

      public SubscriptionItemUpdateParams.Builder setPrice(String price)
      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.

    • setPrice

      public SubscriptionItemUpdateParams.Builder setPrice(EmptyParam price)
      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.

    • setPriceData

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

    • setProrationBehavior

      public SubscriptionItemUpdateParams.Builder setProrationBehavior(SubscriptionItemUpdateParams.ProrationBehavior prorationBehavior)
      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.

    • setProrationDate

      public SubscriptionItemUpdateParams.Builder setProrationDate(Long prorationDate)
      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.

    • setQuantity

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

    • addTaxRate

      public SubscriptionItemUpdateParams.Builder addTaxRate(String element)
      Add an element to `taxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionItemUpdateParams.taxRates for the field documentation.

    • addAllTaxRate

      public SubscriptionItemUpdateParams.Builder addAllTaxRate(List<String> elements)
      Add all elements to `taxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionItemUpdateParams.taxRates for the field documentation.

    • setTaxRates

      public SubscriptionItemUpdateParams.Builder setTaxRates(EmptyParam taxRates)
      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.

    • setTaxRates

      public SubscriptionItemUpdateParams.Builder setTaxRates(List<String> taxRates)
      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.