Package com.stripe.param.checkout

Class SessionUpdateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setCollectedInformation

      public SessionUpdateParams.Builder setCollectedInformation(SessionUpdateParams.CollectedInformation collectedInformation)
      Information about the customer collected within the Checkout Session. Can only be set when updating embedded_page or elements sessions.

    • addExpand

      public SessionUpdateParams.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 SessionUpdateParams.expand for the field documentation.

    • addAllExpand

      public SessionUpdateParams.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 SessionUpdateParams.expand for the field documentation.

    • putExtraParam

      public SessionUpdateParams.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 SessionUpdateParams.extraParams for the field documentation.

    • putAllExtraParam

      public SessionUpdateParams.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 SessionUpdateParams.extraParams for the field documentation.

    • addLineItem

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

    • addAllLineItem

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

    • putMetadata

      public SessionUpdateParams.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 SessionUpdateParams.metadata for the field documentation.

    • putAllMetadata

      public SessionUpdateParams.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 SessionUpdateParams.metadata for the field documentation.

    • setMetadata

      public SessionUpdateParams.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 SessionUpdateParams.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.

    • setPaymentIntentData

      public SessionUpdateParams.Builder setPaymentIntentData(SessionUpdateParams.PaymentIntentData paymentIntentData)
      A subset of parameters to apply to the PaymentIntent for Checkout Sessions in payment mode.

      You can only update these parameters when ui_mode is elements and while the session is active. If the PaymentIntent requires customer action or confirmation, updating these parameters abandons the current payment attempt and returns the PaymentIntent to requires_payment_method. You can't update these parameters after the PaymentIntent begins processing, requires capture, succeeds, or is canceled.

    • addShippingOption

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

    • addAllShippingOption

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

    • setShippingOptions

      public SessionUpdateParams.Builder setShippingOptions(EmptyParam shippingOptions)
      The shipping rate options to apply to this Session. Up to a maximum of 5.

    • setShippingOptions

      public SessionUpdateParams.Builder setShippingOptions(List<SessionUpdateParams.ShippingOption> shippingOptions)
      The shipping rate options to apply to this Session. Up to a maximum of 5.