Package com.stripe.param

Class PaymentLinkUpdateParams.Builder

java.lang.Object

com.stripe.param.PaymentLinkUpdateParams.Builder

Enclosing class:

PaymentLinkUpdateParams

public static class PaymentLinkUpdateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaymentLinkUpdateParams.Builder	addAllCustomField(List<PaymentLinkUpdateParams.CustomField> elements)	Add all elements to `customFields` list.
PaymentLinkUpdateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
PaymentLinkUpdateParams.Builder	addAllLineItem(List<PaymentLinkUpdateParams.LineItem> elements)	Add all elements to `lineItems` list.
PaymentLinkUpdateParams.Builder	addAllPaymentMethodType(List<PaymentLinkUpdateParams.PaymentMethodType> elements)	Add all elements to `paymentMethodTypes` list.
PaymentLinkUpdateParams.Builder	addCustomField(PaymentLinkUpdateParams.CustomField element)	Add an element to `customFields` list.
PaymentLinkUpdateParams.Builder	addExpand(String element)	Add an element to `expand` list.
PaymentLinkUpdateParams.Builder	addLineItem(PaymentLinkUpdateParams.LineItem element)	Add an element to `lineItems` list.
PaymentLinkUpdateParams.Builder	addPaymentMethodType(PaymentLinkUpdateParams.PaymentMethodType element)	Add an element to `paymentMethodTypes` list.
PaymentLinkUpdateParams	build()	Finalize and obtain parameter instance from this builder.
PaymentLinkUpdateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PaymentLinkUpdateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
PaymentLinkUpdateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PaymentLinkUpdateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
PaymentLinkUpdateParams.Builder	setActive(Boolean active)	Whether the payment link's url is active.
PaymentLinkUpdateParams.Builder	setAfterCompletion(PaymentLinkUpdateParams.AfterCompletion afterCompletion)	Behavior after the purchase is complete.
PaymentLinkUpdateParams.Builder	setAllowPromotionCodes(Boolean allowPromotionCodes)	Enables user redeemable promotion codes.
PaymentLinkUpdateParams.Builder	setAutomaticTax(PaymentLinkUpdateParams.AutomaticTax automaticTax)	Configuration for automatic tax collection.
PaymentLinkUpdateParams.Builder	setBillingAddressCollection(PaymentLinkUpdateParams.BillingAddressCollection billingAddressCollection)	Configuration for collecting the customer's billing address.
PaymentLinkUpdateParams.Builder	setCustomerCreation(PaymentLinkUpdateParams.CustomerCreation customerCreation)	Configures whether checkout sessions created by this payment link create a Customer.
PaymentLinkUpdateParams.Builder	setCustomFields(EmptyParam customFields)	Collect additional information from your customer using custom fields.
PaymentLinkUpdateParams.Builder	setCustomFields(List<PaymentLinkUpdateParams.CustomField> customFields)	Collect additional information from your customer using custom fields.
PaymentLinkUpdateParams.Builder	setCustomText(PaymentLinkUpdateParams.CustomText customText)	Display additional text for your customers using custom text.
PaymentLinkUpdateParams.Builder	setInactiveMessage(EmptyParam inactiveMessage)	The custom message to be displayed to a customer when a payment link is no longer active.
PaymentLinkUpdateParams.Builder	setInactiveMessage(String inactiveMessage)	The custom message to be displayed to a customer when a payment link is no longer active.
PaymentLinkUpdateParams.Builder	setInvoiceCreation(PaymentLinkUpdateParams.InvoiceCreation invoiceCreation)	Generate a post-purchase Invoice for one-time payments.
PaymentLinkUpdateParams.Builder	setPaymentIntentData(PaymentLinkUpdateParams.PaymentIntentData paymentIntentData)	A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.
PaymentLinkUpdateParams.Builder	setPaymentMethodCollection(PaymentLinkUpdateParams.PaymentMethodCollection paymentMethodCollection)	Specify whether Checkout should collect a payment method.
PaymentLinkUpdateParams.Builder	setPaymentMethodTypes(EmptyParam paymentMethodTypes)	The list of payment method types that customers can use.
PaymentLinkUpdateParams.Builder	setPaymentMethodTypes(List<PaymentLinkUpdateParams.PaymentMethodType> paymentMethodTypes)	The list of payment method types that customers can use.
PaymentLinkUpdateParams.Builder	setRestrictions(EmptyParam restrictions)	Settings that restrict the usage of a payment link.
PaymentLinkUpdateParams.Builder	setRestrictions(PaymentLinkUpdateParams.Restrictions restrictions)	Settings that restrict the usage of a payment link.
PaymentLinkUpdateParams.Builder	setShippingAddressCollection(EmptyParam shippingAddressCollection)	Configuration for collecting the customer's shipping address.
PaymentLinkUpdateParams.Builder	setShippingAddressCollection(PaymentLinkUpdateParams.ShippingAddressCollection shippingAddressCollection)	Configuration for collecting the customer's shipping address.
PaymentLinkUpdateParams.Builder	setSubscriptionData(PaymentLinkUpdateParams.SubscriptionData subscriptionData)	When creating a subscription, the specified configuration data will be used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public PaymentLinkUpdateParams build()

Finalize and obtain parameter instance from this builder.

setActive

public PaymentLinkUpdateParams.Builder setActive(Boolean active)

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.

setAfterCompletion

public PaymentLinkUpdateParams.Builder setAfterCompletion(PaymentLinkUpdateParams.AfterCompletion afterCompletion)

Behavior after the purchase is complete.

setAllowPromotionCodes

public PaymentLinkUpdateParams.Builder setAllowPromotionCodes(Boolean allowPromotionCodes)

Enables user redeemable promotion codes.

setAutomaticTax

public PaymentLinkUpdateParams.Builder setAutomaticTax(PaymentLinkUpdateParams.AutomaticTax automaticTax)

Configuration for automatic tax collection.

setBillingAddressCollection

public PaymentLinkUpdateParams.Builder setBillingAddressCollection(PaymentLinkUpdateParams.BillingAddressCollection billingAddressCollection)

Configuration for collecting the customer's billing address. Defaults to auto.

addCustomField

public PaymentLinkUpdateParams.Builder addCustomField(PaymentLinkUpdateParams.CustomField element)

Add an element to `customFields` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentLinkUpdateParams.customFields for the field documentation.

addAllCustomField

public PaymentLinkUpdateParams.Builder addAllCustomField(List<PaymentLinkUpdateParams.CustomField> elements)

Add all elements to `customFields` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentLinkUpdateParams.customFields for the field documentation.

setCustomFields

public PaymentLinkUpdateParams.Builder setCustomFields(EmptyParam customFields)

Collect additional information from your customer using custom fields. Up to 3 fields are supported.

setCustomFields

public PaymentLinkUpdateParams.Builder setCustomFields(List<PaymentLinkUpdateParams.CustomField> customFields)

Collect additional information from your customer using custom fields. Up to 3 fields are supported.

setCustomText

public PaymentLinkUpdateParams.Builder setCustomText(PaymentLinkUpdateParams.CustomText customText)

Display additional text for your customers using custom text.

setCustomerCreation

public PaymentLinkUpdateParams.Builder setCustomerCreation(PaymentLinkUpdateParams.CustomerCreation customerCreation)

Configures whether checkout sessions created by this payment link create a Customer.

addExpand

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

addAllExpand

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

putExtraParam

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

putAllExtraParam

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

setInactiveMessage

public PaymentLinkUpdateParams.Builder setInactiveMessage(String inactiveMessage)

The custom message to be displayed to a customer when a payment link is no longer active.

setInactiveMessage

public PaymentLinkUpdateParams.Builder setInactiveMessage(EmptyParam inactiveMessage)

The custom message to be displayed to a customer when a payment link is no longer active.

setInvoiceCreation

public PaymentLinkUpdateParams.Builder setInvoiceCreation(PaymentLinkUpdateParams.InvoiceCreation invoiceCreation)

Generate a post-purchase Invoice for one-time payments.

addLineItem

public PaymentLinkUpdateParams.Builder addLineItem(PaymentLinkUpdateParams.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 PaymentLinkUpdateParams.lineItems for the field documentation.

addAllLineItem

public PaymentLinkUpdateParams.Builder addAllLineItem(List<PaymentLinkUpdateParams.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 PaymentLinkUpdateParams.lineItems for the field documentation.

putMetadata

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

putAllMetadata

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

setPaymentIntentData

public PaymentLinkUpdateParams.Builder setPaymentIntentData(PaymentLinkUpdateParams.PaymentIntentData paymentIntentData)

A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.

setPaymentMethodCollection

public PaymentLinkUpdateParams.Builder setPaymentMethodCollection(PaymentLinkUpdateParams.PaymentMethodCollection paymentMethodCollection)

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.

addPaymentMethodType

public PaymentLinkUpdateParams.Builder addPaymentMethodType(PaymentLinkUpdateParams.PaymentMethodType element)

Add an element to `paymentMethodTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentLinkUpdateParams.paymentMethodTypes for the field documentation.

addAllPaymentMethodType

public PaymentLinkUpdateParams.Builder addAllPaymentMethodType(List<PaymentLinkUpdateParams.PaymentMethodType> elements)

Add all elements to `paymentMethodTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentLinkUpdateParams.paymentMethodTypes for the field documentation.

setPaymentMethodTypes

public PaymentLinkUpdateParams.Builder setPaymentMethodTypes(EmptyParam paymentMethodTypes)

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.

setPaymentMethodTypes

public PaymentLinkUpdateParams.Builder setPaymentMethodTypes(List<PaymentLinkUpdateParams.PaymentMethodType> paymentMethodTypes)

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.

setRestrictions

public PaymentLinkUpdateParams.Builder setRestrictions(PaymentLinkUpdateParams.Restrictions restrictions)

Settings that restrict the usage of a payment link.

setRestrictions

public PaymentLinkUpdateParams.Builder setRestrictions(EmptyParam restrictions)

Settings that restrict the usage of a payment link.

setShippingAddressCollection

public PaymentLinkUpdateParams.Builder setShippingAddressCollection(PaymentLinkUpdateParams.ShippingAddressCollection shippingAddressCollection)

Configuration for collecting the customer's shipping address.

setShippingAddressCollection

public PaymentLinkUpdateParams.Builder setShippingAddressCollection(EmptyParam shippingAddressCollection)

Configuration for collecting the customer's shipping address.

setSubscriptionData

public PaymentLinkUpdateParams.Builder setSubscriptionData(PaymentLinkUpdateParams.SubscriptionData subscriptionData)

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.