SessionCreateParams.Builder (stripe-java 10.0.2 API)

java.lang.Object
- com.stripe.param.checkout.SessionCreateParams.Builder

Enclosing class:: SessionCreateParams

public static class SessionCreateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SessionCreateParams.Builder`	`addAllExpand(java.util.List<java.lang.String> elements)` Add all elements to `expand` list.
`SessionCreateParams.Builder`	`addAllLineItem(java.util.List<SessionCreateParams.LineItem> elements)` Add all elements to `lineItems` list.
`SessionCreateParams.Builder`	`addAllPaymentMethodType(java.util.List<SessionCreateParams.PaymentMethodType> elements)` Add all elements to `paymentMethodTypes` list.
`SessionCreateParams.Builder`	`addExpand(java.lang.String element)` Add an element to `expand` list.
`SessionCreateParams.Builder`	`addLineItem(SessionCreateParams.LineItem element)` Add an element to `lineItems` list.
`SessionCreateParams.Builder`	`addPaymentMethodType(SessionCreateParams.PaymentMethodType element)` Add an element to `paymentMethodTypes` list.
`SessionCreateParams`	`build()` Finalize and obtain parameter instance from this builder.
`SessionCreateParams.Builder`	`putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)` Add all map key/value pairs to `extraParams` map.
`SessionCreateParams.Builder`	`putExtraParam(java.lang.String key, java.lang.Object value)` Add a key/value pair to `extraParams` map.
`SessionCreateParams.Builder`	`setBillingAddressCollection(SessionCreateParams.BillingAddressCollection billingAddressCollection)` Specify whether Checkout should collect the customer's billing address.
`SessionCreateParams.Builder`	`setCancelUrl(java.lang.String cancelUrl)` The URL the customer will be directed to if they decide to cancel payment and return to your website.
`SessionCreateParams.Builder`	`setClientReferenceId(java.lang.String clientReferenceId)` A unique string to reference the Checkout Session.
`SessionCreateParams.Builder`	`setCustomer(java.lang.String customer)` ID of an existing customer paying for this session, if one exists.
`SessionCreateParams.Builder`	`setCustomerEmail(java.lang.String customerEmail)` If provided, this value will be used when the Customer object is created.
`SessionCreateParams.Builder`	`setLocale(SessionCreateParams.Locale locale)` The IETF language tag of the locale Checkout is displayed in.
`SessionCreateParams.Builder`	`setPaymentIntentData(SessionCreateParams.PaymentIntentData paymentIntentData)` A subset of parameters to be passed to PaymentIntent creation.
`SessionCreateParams.Builder`	`setSubscriptionData(SessionCreateParams.SubscriptionData subscriptionData)` A subset of parameters to be passed to subscription creation.
`SessionCreateParams.Builder`	`setSuccessUrl(java.lang.String successUrl)` The URL the customer will be directed to after the payment or subscription creation is successful.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public SessionCreateParams build()
```
    Finalize and obtain parameter instance from this builder.
  - setBillingAddressCollection
```
public SessionCreateParams.Builder setBillingAddressCollection(SessionCreateParams.BillingAddressCollection billingAddressCollection)
```
    Specify whether Checkout should collect the customer's billing address. If set to `required`, Checkout will always collect the customer's billing address. If left blank or set to `auto` Checkout will only collect the billing address when necessary.
  - setCancelUrl
```
public SessionCreateParams.Builder setCancelUrl(java.lang.String cancelUrl)
```
    The URL the customer will be directed to if they decide to cancel payment and return to your website.
  - setClientReferenceId
```
public SessionCreateParams.Builder setClientReferenceId(java.lang.String clientReferenceId)
```
    A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
  - setCustomer
```
public SessionCreateParams.Builder setCustomer(java.lang.String customer)
```
    ID of an existing customer paying for this session, if one exists. May only be used with line_items. Usage with subscription_data is not yet available. If blank, Checkout will create a new customer object based on information provided during the session. The email stored on the customer will be used to prefill the email field on the Checkout page. If the customer changes their email on the Checkout page, the Customer object will be updated with the new email.
  - setCustomerEmail
```
public SessionCreateParams.Builder setCustomerEmail(java.lang.String customerEmail)
```
    If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete, use the `customer` field.
  - addExpand
```
public SessionCreateParams.Builder addExpand(java.lang.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 SessionCreateParams.expand for the field documentation.
  - addAllExpand
```
public SessionCreateParams.Builder addAllExpand(java.util.List<java.lang.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 SessionCreateParams.expand for the field documentation.
  - putExtraParam
```
public SessionCreateParams.Builder putExtraParam(java.lang.String key,
                                                 java.lang.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 SessionCreateParams.extraParams for the field documentation.
  - putAllExtraParam
```
public SessionCreateParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.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 SessionCreateParams.extraParams for the field documentation.
  - addLineItem
```
public SessionCreateParams.Builder addLineItem(SessionCreateParams.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 SessionCreateParams.lineItems for the field documentation.
  - addAllLineItem
```
public SessionCreateParams.Builder addAllLineItem(java.util.List<SessionCreateParams.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 SessionCreateParams.lineItems for the field documentation.
  - setLocale
```
public SessionCreateParams.Builder setLocale(SessionCreateParams.Locale locale)
```
    The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. Supported values are `auto`, `da`, `de`, `en`, `es`, `fi`, `fr`, `it`, `ja`, `nb`, `nl`, `pl`, `pt`, `sv`, or `zh`.
  - setPaymentIntentData
```
public SessionCreateParams.Builder setPaymentIntentData(SessionCreateParams.PaymentIntentData paymentIntentData)
```
    A subset of parameters to be passed to PaymentIntent creation.
  - addPaymentMethodType
```
public SessionCreateParams.Builder addPaymentMethodType(SessionCreateParams.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 SessionCreateParams.paymentMethodTypes for the field documentation.
  - addAllPaymentMethodType
```
public SessionCreateParams.Builder addAllPaymentMethodType(java.util.List<SessionCreateParams.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 SessionCreateParams.paymentMethodTypes for the field documentation.
  - setSubscriptionData
```
public SessionCreateParams.Builder setSubscriptionData(SessionCreateParams.SubscriptionData subscriptionData)
```
    A subset of parameters to be passed to subscription creation.
  - setSuccessUrl
```
public SessionCreateParams.Builder setSuccessUrl(java.lang.String successUrl)
```
    The URL the customer will be directed to after the payment or subscription creation is successful.

Class SessionCreateParams.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setBillingAddressCollection

setCancelUrl

setClientReferenceId

setCustomer

setCustomerEmail

addExpand

addAllExpand

putExtraParam

putAllExtraParam

addLineItem

addAllLineItem

setLocale

setPaymentIntentData

addPaymentMethodType

addAllPaymentMethodType

setSubscriptionData

setSuccessUrl