Package com.stripe.param.checkout

Class SessionCreateParams.PaymentIntentData

java.lang.Object
com.stripe.param.checkout.SessionCreateParams.PaymentIntentData
Enclosing class:
SessionCreateParams
public static class SessionCreateParams.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 SessionCreateParams.PaymentIntentData.Builder builder()

    • getApplicationFeeAmount

      public Long getApplicationFeeAmount()
      The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

    • getCaptureMethod

      public SessionCreateParams.PaymentIntentData.CaptureMethod getCaptureMethod()
      Controls when the funds will be captured from the customer's account.

    • getDescription

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.

    • 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 Map<String,String> 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.

    • getOnBehalfOf

      public String getOnBehalfOf()
      The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.

    • getReceiptEmail

      public String getReceiptEmail()
      Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

    • getSetupFutureUsage

      public SessionCreateParams.PaymentIntentData.SetupFutureUsage 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.

    • getShipping

      public SessionCreateParams.PaymentIntentData.Shipping getShipping()
      Shipping information for this payment.

    • getStatementDescriptor

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

    • getStatementDescriptorSuffix

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

    • getTransferData

      public SessionCreateParams.PaymentIntentData.TransferData getTransferData()
      The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.

    • getTransferGroup

      public String getTransferGroup()
      A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.