Package com.stripe.param

Class PaymentLinkCreateParams.Builder

java.lang.Object

com.stripe.param.PaymentLinkCreateParams.Builder

Enclosing class:

PaymentLinkCreateParams

public static class PaymentLinkCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaymentLinkCreateParams.Builder	addAllCustomField(List<PaymentLinkCreateParams.CustomField> elements)	Add all elements to `customFields` list.
PaymentLinkCreateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
PaymentLinkCreateParams.Builder	addAllLineItem(List<PaymentLinkCreateParams.LineItem> elements)	Add all elements to `lineItems` list.
PaymentLinkCreateParams.Builder	addAllPaymentMethodType(List<PaymentLinkCreateParams.PaymentMethodType> elements)	Add all elements to `paymentMethodTypes` list.
PaymentLinkCreateParams.Builder	addAllShippingOption(List<PaymentLinkCreateParams.ShippingOption> elements)	Add all elements to `shippingOptions` list.
PaymentLinkCreateParams.Builder	addCustomField(PaymentLinkCreateParams.CustomField element)	Add an element to `customFields` list.
PaymentLinkCreateParams.Builder	addExpand(String element)	Add an element to `expand` list.
PaymentLinkCreateParams.Builder	addLineItem(PaymentLinkCreateParams.LineItem element)	Add an element to `lineItems` list.
PaymentLinkCreateParams.Builder	addPaymentMethodType(PaymentLinkCreateParams.PaymentMethodType element)	Add an element to `paymentMethodTypes` list.
PaymentLinkCreateParams.Builder	addShippingOption(PaymentLinkCreateParams.ShippingOption element)	Add an element to `shippingOptions` list.
PaymentLinkCreateParams	build()	Finalize and obtain parameter instance from this builder.
PaymentLinkCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PaymentLinkCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
PaymentLinkCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PaymentLinkCreateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
PaymentLinkCreateParams.Builder	setAfterCompletion(PaymentLinkCreateParams.AfterCompletion afterCompletion)	Behavior after the purchase is complete.
PaymentLinkCreateParams.Builder	setAllowPromotionCodes(Boolean allowPromotionCodes)	Enables user redeemable promotion codes.
PaymentLinkCreateParams.Builder	setApplicationFeeAmount(Long applicationFeeAmount)	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.
PaymentLinkCreateParams.Builder	setApplicationFeePercent(BigDecimal applicationFeePercent)	A non-negative decimal between 0 and 100, with at most two decimal places.
PaymentLinkCreateParams.Builder	setAutomaticTax(PaymentLinkCreateParams.AutomaticTax automaticTax)	Configuration for automatic tax collection.
PaymentLinkCreateParams.Builder	setBillingAddressCollection(PaymentLinkCreateParams.BillingAddressCollection billingAddressCollection)	Configuration for collecting the customer's billing address.
PaymentLinkCreateParams.Builder	setConsentCollection(PaymentLinkCreateParams.ConsentCollection consentCollection)	Configure fields to gather active consent from customers.
PaymentLinkCreateParams.Builder	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
PaymentLinkCreateParams.Builder	setCustomerCreation(PaymentLinkCreateParams.CustomerCreation customerCreation)	Configures whether checkout sessions created by this payment link create a Customer.
PaymentLinkCreateParams.Builder	setCustomText(PaymentLinkCreateParams.CustomText customText)	Display additional text for your customers using custom text.
PaymentLinkCreateParams.Builder	setInactiveMessage(String inactiveMessage)	The custom message to be displayed to a customer when a payment link is no longer active.
PaymentLinkCreateParams.Builder	setInvoiceCreation(PaymentLinkCreateParams.InvoiceCreation invoiceCreation)	Generate a post-purchase Invoice for one-time payments.
PaymentLinkCreateParams.Builder	setOnBehalfOf(String onBehalfOf)	The account on behalf of which to charge.
PaymentLinkCreateParams.Builder	setPaymentIntentData(PaymentLinkCreateParams.PaymentIntentData paymentIntentData)	A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.
PaymentLinkCreateParams.Builder	setPaymentMethodCollection(PaymentLinkCreateParams.PaymentMethodCollection paymentMethodCollection)	Specify whether Checkout should collect a payment method.
PaymentLinkCreateParams.Builder	setPhoneNumberCollection(PaymentLinkCreateParams.PhoneNumberCollection phoneNumberCollection)	Controls phone number collection settings during checkout.
PaymentLinkCreateParams.Builder	setRestrictions(PaymentLinkCreateParams.Restrictions restrictions)	Settings that restrict the usage of a payment link.
PaymentLinkCreateParams.Builder	setShippingAddressCollection(PaymentLinkCreateParams.ShippingAddressCollection shippingAddressCollection)	Configuration for collecting the customer's shipping address.
PaymentLinkCreateParams.Builder	setSubmitType(PaymentLinkCreateParams.SubmitType submitType)	Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button.
PaymentLinkCreateParams.Builder	setSubscriptionData(PaymentLinkCreateParams.SubscriptionData subscriptionData)	When creating a subscription, the specified configuration data will be used.
PaymentLinkCreateParams.Builder	setTaxIdCollection(PaymentLinkCreateParams.TaxIdCollection taxIdCollection)	Controls tax ID collection during checkout.
PaymentLinkCreateParams.Builder	setTransferData(PaymentLinkCreateParams.TransferData transferData)	The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.

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 PaymentLinkCreateParams build()

Finalize and obtain parameter instance from this builder.

setAfterCompletion

public PaymentLinkCreateParams.Builder setAfterCompletion(PaymentLinkCreateParams.AfterCompletion afterCompletion)

Behavior after the purchase is complete.

setAllowPromotionCodes

public PaymentLinkCreateParams.Builder setAllowPromotionCodes(Boolean allowPromotionCodes)

Enables user redeemable promotion codes.

setApplicationFeeAmount

public PaymentLinkCreateParams.Builder setApplicationFeeAmount(Long applicationFeeAmount)

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.

setApplicationFeePercent

public PaymentLinkCreateParams.Builder setApplicationFeePercent(BigDecimal applicationFeePercent)

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.

setAutomaticTax

public PaymentLinkCreateParams.Builder setAutomaticTax(PaymentLinkCreateParams.AutomaticTax automaticTax)

Configuration for automatic tax collection.

setBillingAddressCollection

public PaymentLinkCreateParams.Builder setBillingAddressCollection(PaymentLinkCreateParams.BillingAddressCollection billingAddressCollection)

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

setConsentCollection

public PaymentLinkCreateParams.Builder setConsentCollection(PaymentLinkCreateParams.ConsentCollection consentCollection)

Configure fields to gather active consent from customers.

setCurrency

public PaymentLinkCreateParams.Builder setCurrency(String currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency and supported by each line item's price.

addCustomField

public PaymentLinkCreateParams.Builder addCustomField(PaymentLinkCreateParams.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 PaymentLinkCreateParams.customFields for the field documentation.

addAllCustomField

public PaymentLinkCreateParams.Builder addAllCustomField(List<PaymentLinkCreateParams.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 PaymentLinkCreateParams.customFields for the field documentation.

setCustomText

public PaymentLinkCreateParams.Builder setCustomText(PaymentLinkCreateParams.CustomText customText)

Display additional text for your customers using custom text.

setCustomerCreation

public PaymentLinkCreateParams.Builder setCustomerCreation(PaymentLinkCreateParams.CustomerCreation customerCreation)

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

addExpand

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

addAllExpand

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

putExtraParam

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

putAllExtraParam

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

setInactiveMessage

public PaymentLinkCreateParams.Builder setInactiveMessage(String inactiveMessage)

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

setInvoiceCreation

public PaymentLinkCreateParams.Builder setInvoiceCreation(PaymentLinkCreateParams.InvoiceCreation invoiceCreation)

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

addLineItem

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

addAllLineItem

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

putMetadata

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

putAllMetadata

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

setOnBehalfOf

public PaymentLinkCreateParams.Builder setOnBehalfOf(String onBehalfOf)

The account on behalf of which to charge.

setPaymentIntentData

public PaymentLinkCreateParams.Builder setPaymentIntentData(PaymentLinkCreateParams.PaymentIntentData paymentIntentData)

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

setPaymentMethodCollection

public PaymentLinkCreateParams.Builder setPaymentMethodCollection(PaymentLinkCreateParams.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 PaymentLinkCreateParams.Builder addPaymentMethodType(PaymentLinkCreateParams.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 PaymentLinkCreateParams.paymentMethodTypes for the field documentation.

addAllPaymentMethodType

public PaymentLinkCreateParams.Builder addAllPaymentMethodType(List<PaymentLinkCreateParams.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 PaymentLinkCreateParams.paymentMethodTypes for the field documentation.

setPhoneNumberCollection

public PaymentLinkCreateParams.Builder setPhoneNumberCollection(PaymentLinkCreateParams.PhoneNumberCollection phoneNumberCollection)

Controls phone number collection settings during checkout.

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

setRestrictions

public PaymentLinkCreateParams.Builder setRestrictions(PaymentLinkCreateParams.Restrictions restrictions)

Settings that restrict the usage of a payment link.

setShippingAddressCollection

public PaymentLinkCreateParams.Builder setShippingAddressCollection(PaymentLinkCreateParams.ShippingAddressCollection shippingAddressCollection)

Configuration for collecting the customer's shipping address.

addShippingOption

public PaymentLinkCreateParams.Builder addShippingOption(PaymentLinkCreateParams.ShippingOption element)

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

addAllShippingOption

public PaymentLinkCreateParams.Builder addAllShippingOption(List<PaymentLinkCreateParams.ShippingOption> elements)

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

setSubmitType

public PaymentLinkCreateParams.Builder setSubmitType(PaymentLinkCreateParams.SubmitType submitType)

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: donate.stripe.com).

setSubscriptionData

public PaymentLinkCreateParams.Builder setSubscriptionData(PaymentLinkCreateParams.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.

setTaxIdCollection

public PaymentLinkCreateParams.Builder setTaxIdCollection(PaymentLinkCreateParams.TaxIdCollection taxIdCollection)

Controls tax ID collection during checkout.

setTransferData

public PaymentLinkCreateParams.Builder setTransferData(PaymentLinkCreateParams.TransferData transferData)

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