Class PaymentLinkUpdateParams


public class PaymentLinkUpdateParams extends ApiRequestParams
  • Method Details

    • builder

      public static PaymentLinkUpdateParams.Builder builder()
    • getActive

      public Boolean getActive()
      Whether the payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.
    • getAfterCompletion

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

      public Boolean getAllowPromotionCodes()
      Enables user redeemable promotion codes.
    • getAutomaticTax

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

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

      public Object getCustomFields()
      Collect additional information from your customer using custom fields. Up to 3 fields are supported.
    • getCustomText

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

      public PaymentLinkUpdateParams.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 Object getInactiveMessage()
      The custom message to be displayed to a customer when a payment link is no longer active.
    • getInvoiceCreation

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

      public List<PaymentLinkUpdateParams.LineItem> getLineItems()
      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.
    • getPaymentIntentData

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

      public PaymentLinkUpdateParams.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 Object getPaymentMethodTypes()
      The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your payment method settings.
    • getRestrictions

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

      public Object getShippingAddressCollection()
      Configuration for collecting the customer's shipping address.
    • getSubscriptionData

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