Package com.stripe.param.checkout

Class SessionCreateParams.ConsentCollection

java.lang.Object

com.stripe.param.checkout.SessionCreateParams.ConsentCollection

Enclosing class:

SessionCreateParams

public static class SessionCreateParams.ConsentCollection
extends Object

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 SessionCreateParams.AutomaticTax.extraParams for the field documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionCreateParams.ConsentCollection.Builder
static enum	SessionCreateParams.ConsentCollection.Promotions
static enum	SessionCreateParams.ConsentCollection.TermsOfService

Method Summary

Modifier and Type	Method	Description
static SessionCreateParams.ConsentCollection.Builder	builder()
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
SessionCreateParams.ConsentCollection.Promotions	getPromotions()	If set to auto, enables the collection of customer consent for promotional communications.
SessionCreateParams.ConsentCollection.TermsOfService	getTermsOfService()	If set to required, it requires customers to check a terms of service checkbox before being able to pay.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SessionCreateParams.ConsentCollection.Builder builder()

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.

getPromotions

public SessionCreateParams.ConsentCollection.Promotions getPromotions()

If set to auto, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer's locale. Only available to US merchants.

getTermsOfService

public SessionCreateParams.ConsentCollection.TermsOfService getTermsOfService()

If set to required, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your Dashboard settings.