Package com.stripe.param.checkout

Class SessionCreateParams.CustomField

java.lang.Object

com.stripe.param.checkout.SessionCreateParams.CustomField

Enclosing class:

SessionCreateParams

public static class SessionCreateParams.CustomField
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionCreateParams.CustomField.Builder
static class	SessionCreateParams.CustomField.Dropdown
static class	SessionCreateParams.CustomField.Label	Required. The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer.
static class	SessionCreateParams.CustomField.Numeric
static class	SessionCreateParams.CustomField.Text	The minimum character length requirement for the customer's input.
static enum	SessionCreateParams.CustomField.Type	The minimum character length requirement for the customer's input.

Method Summary

Modifier and Type	Method	Description
static SessionCreateParams.CustomField.Builder	builder()
SessionCreateParams.CustomField.Dropdown	getDropdown()	Configuration for type=dropdown fields.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
String	getKey()	Required. String of your choice that your integration can use to reconcile this field.
SessionCreateParams.CustomField.Label	getLabel()	Required. The label for the field, displayed to the customer.
SessionCreateParams.CustomField.Numeric	getNumeric()	Configuration for type=numeric fields.
Boolean	getOptional()	Whether the customer is required to complete the field before completing the Checkout Session.
SessionCreateParams.CustomField.Text	getText()	Configuration for type=text fields.
SessionCreateParams.CustomField.Type	getType()	Required. The type of the field.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SessionCreateParams.CustomField.Builder builder()

getDropdown

public SessionCreateParams.CustomField.Dropdown getDropdown()

Configuration for type=dropdown fields.

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.

getKey

public String getKey()

Required. String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.

getLabel

public SessionCreateParams.CustomField.Label getLabel()

Required. The label for the field, displayed to the customer.

getNumeric

public SessionCreateParams.CustomField.Numeric getNumeric()

Configuration for type=numeric fields.

getOptional

public Boolean getOptional()

Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.

getText

public SessionCreateParams.CustomField.Text getText()

Configuration for type=text fields.

getType

public SessionCreateParams.CustomField.Type getType()

Required. The type of the field.