Class PaymentLinkCreateParams


public class PaymentLinkCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static PaymentLinkCreateParams.Builder builder()
    • getAfterCompletion

      public PaymentLinkCreateParams.AfterCompletion getAfterCompletion()
      Behavior after the purchase is complete.
    • getAllowPromotionCodes

      public Boolean getAllowPromotionCodes()
      Enables user redeemable promotion codes.
    • 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. Can only be applied when there are no line items with recurring prices.
    • getApplicationFeePercent

      public BigDecimal getApplicationFeePercent()
      A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
    • getAutomaticTax

      public PaymentLinkCreateParams.AutomaticTax getAutomaticTax()
      Configuration for automatic tax collection.
    • getBillingAddressCollection

      public PaymentLinkCreateParams.BillingAddressCollection getBillingAddressCollection()
      Configuration for collecting the customer's billing address. Defaults to auto.
    • getConsentCollection

      public PaymentLinkCreateParams.ConsentCollection getConsentCollection()
      Configure fields to gather active consent from customers.
    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency and supported by each line item's price.
    • getCustomFields

      public List<PaymentLinkCreateParams.CustomField> getCustomFields()
      Collect additional information from your customer using custom fields. Up to 3 fields are supported.
    • getCustomText

      public PaymentLinkCreateParams.CustomText getCustomText()
      Display additional text for your customers using custom text.
    • getCustomerCreation

      public PaymentLinkCreateParams.CustomerCreation getCustomerCreation()
      Configures whether checkout sessions created by this payment link create a Customer.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • 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.
    • getInactiveMessage

      public String getInactiveMessage()
      The custom message to be displayed to a customer when a payment link is no longer active.
    • getInvoiceCreation

      public PaymentLinkCreateParams.InvoiceCreation getInvoiceCreation()
      Generate a post-purchase Invoice for one-time payments.
    • getLineItems

      public List<PaymentLinkCreateParams.LineItem> getLineItems()
      Required. The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
    • 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. Metadata associated with this Payment Link will automatically be copied to checkout sessions created by this payment link.
    • getOnBehalfOf

      public String getOnBehalfOf()
      The account on behalf of which to charge.
    • getPaymentIntentData

      public PaymentLinkCreateParams.PaymentIntentData getPaymentIntentData()
      A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.
    • getPaymentMethodCollection

      public PaymentLinkCreateParams.PaymentMethodCollection getPaymentMethodCollection()
      Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.

      Can only be set in subscription mode. Defaults to always.

      If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial.

    • getPaymentMethodTypes

      public List<PaymentLinkCreateParams.PaymentMethodType> getPaymentMethodTypes()
      The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your payment method settings (20+ payment methods supported).
    • getPhoneNumberCollection

      public PaymentLinkCreateParams.PhoneNumberCollection getPhoneNumberCollection()
      Controls phone number collection settings during checkout.

      We recommend that you review your privacy policy and check with your legal contacts.

    • getRestrictions

      public PaymentLinkCreateParams.Restrictions getRestrictions()
      Settings that restrict the usage of a payment link.
    • getShippingAddressCollection

      public PaymentLinkCreateParams.ShippingAddressCollection getShippingAddressCollection()
      Configuration for collecting the customer's shipping address.
    • getShippingOptions

      public List<PaymentLinkCreateParams.ShippingOption> getShippingOptions()
      The shipping rate options to apply to checkout sessions created by this payment link.
    • getSubmitType

      public PaymentLinkCreateParams.SubmitType getSubmitType()
      Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the url property (example:
    • getSubscriptionData

      public PaymentLinkCreateParams.SubscriptionData getSubscriptionData()
      When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data.
    • getTaxIdCollection

      public PaymentLinkCreateParams.TaxIdCollection getTaxIdCollection()
      Controls tax ID collection during checkout.
    • getTransferData

      public PaymentLinkCreateParams.TransferData getTransferData()
      The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.