Package com.stripe.param.checkout

Class SessionUpdateParams.PaymentIntentData

java.lang.Object
com.stripe.param.checkout.SessionUpdateParams.PaymentIntentData
Enclosing class:
SessionUpdateParams
public static class SessionUpdateParams.PaymentIntentData extends Object
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).

  • Method Details

    • builder

      public static SessionUpdateParams.PaymentIntentData.Builder builder()

    • getDescription

      public Object getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users. Pass an empty string to clear a previously configured value.

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

    • getSetupFutureUsage

      public ApiRequestParams.EnumParam getSetupFutureUsage()
      Indicates that you intend to make future payments with the payment method collected by this Checkout Session.

      When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved.

      When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.

      If a Customer has been provided or Checkout creates a new Customer, Checkout will attach the payment method to the Customer.

      If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.

      When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

      You must wrap any Checkout Session update that mutates setup_future_usage in runServerUpdate and await it before continuing with the payment. Pass an empty string to remove a previously supplied configuration.

    • getStatementDescriptor

      public Object getStatementDescriptor()
      Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

      Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead. Pass an empty string to clear a previously configured value.

    • getStatementDescriptorSuffix

      public Object getStatementDescriptorSuffix()
      Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement. Pass an empty string to clear a previously configured value.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object