Package com.stripe.param
Class PaymentLinkCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.PaymentLinkCreateParams
-
public class PaymentLinkCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PaymentLinkCreateParams.AfterCompletion
static class
PaymentLinkCreateParams.AutomaticTax
static class
PaymentLinkCreateParams.BillingAddressCollection
Add all map key/value pairs to `extraParams` map.static class
PaymentLinkCreateParams.Builder
static class
PaymentLinkCreateParams.LineItem
Add all map key/value pairs to `extraParams` map.static class
PaymentLinkCreateParams.PaymentMethodType
static class
PaymentLinkCreateParams.PhoneNumberCollection
The minimum quantity the customer can purchase.static class
PaymentLinkCreateParams.ShippingAddressCollection
Add all map key/value pairs to `extraParams` map.static class
PaymentLinkCreateParams.SubscriptionData
static class
PaymentLinkCreateParams.TransferData
Integer representing the number of trial period days before the customer is charged for the first time.-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PaymentLinkCreateParams.Builder
builder()
PaymentLinkCreateParams.AfterCompletion
getAfterCompletion()
Behavior after the purchase is complete.java.lang.Boolean
getAllowPromotionCodes()
Enables user redeemable promotion codes.java.lang.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.java.math.BigDecimal
getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places.PaymentLinkCreateParams.AutomaticTax
getAutomaticTax()
Configuration for automatic tax collection.PaymentLinkCreateParams.BillingAddressCollection
getBillingAddressCollection()
Configuration for collecting the customer's billing address.java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.java.util.List<PaymentLinkCreateParams.LineItem>
getLineItems()
The line items representing what is being sold.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getOnBehalfOf()
The account on behalf of which to charge.java.util.List<PaymentLinkCreateParams.PaymentMethodType>
getPaymentMethodTypes()
The list of payment method types that customers can use.PaymentLinkCreateParams.PhoneNumberCollection
getPhoneNumberCollection()
Controls phone number collection settings during checkout.PaymentLinkCreateParams.ShippingAddressCollection
getShippingAddressCollection()
Configuration for collecting the customer's shipping address.PaymentLinkCreateParams.SubscriptionData
getSubscriptionData()
When creating a subscription, the specified configuration data will be used.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.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static PaymentLinkCreateParams.Builder builder()
-
getAfterCompletion
public PaymentLinkCreateParams.AfterCompletion getAfterCompletion()
Behavior after the purchase is complete.
-
getAllowPromotionCodes
public java.lang.Boolean getAllowPromotionCodes()
Enables user redeemable promotion codes.
-
getApplicationFeeAmount
public java.lang.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 java.math.BigDecimal getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal 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.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExtraParams
public java.util.Map<java.lang.String,java.lang.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.
-
getLineItems
public java.util.List<PaymentLinkCreateParams.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 java.util.Map<java.lang.String,java.lang.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 tometadata
. Metadata associated with this Payment Link will automatically be copied to checkout sessions created by this payment link.
-
getOnBehalfOf
public java.lang.String getOnBehalfOf()
The account on behalf of which to charge.
-
getPaymentMethodTypes
public java.util.List<PaymentLinkCreateParams.PaymentMethodType> getPaymentMethodTypes()
The list of payment method types that customers can use. Onlycard
is supported. 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.
-
getShippingAddressCollection
public PaymentLinkCreateParams.ShippingAddressCollection getShippingAddressCollection()
Configuration for collecting the customer's shipping address.
-
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 usesubscription_data
.
-
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.
-
-