Package com.stripe.param

Class SubscriptionItemUpdateParams.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

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

      • putAllExtraParam

        public SubscriptionItemUpdateParams.Builder putAllExtraParam​(java.util.Map<java.lang.String,​java.lang.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.

      • putAllMetadata

        public SubscriptionItemUpdateParams.Builder putAllMetadata​(java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.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​(java.lang.Boolean offSession)
        Indicates if a customer is on or off-session while an invoice payment is attempted.

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

      • setPrice

        public SubscriptionItemUpdateParams.Builder setPrice​(java.lang.String price)
        The ID of the price object. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.

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

      • setProrationDate

        public SubscriptionItemUpdateParams.Builder setProrationDate​(java.lang.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.