Session (stripe-java 19.45.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.checkout.Session

All Implemented Interfaces:: HasId, StripeObjectInterface

public class Session
extends ApiResource
implements HasId

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Session.DisplayItem`
`static class`	`Session.ShippingAddressCollection` The name of the line item.
`static class`	`Session.TotalDetails`

Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod

Field Summary
- Fields inherited from class com.stripe.net.ApiResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

Session()

Constructors
Constructor and Description
`Session()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`static Session`	`create(java.util.Map<java.lang.String,java.lang.Object> params)` Creates a Session object.
`static Session`	`create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Creates a Session object.
`static Session`	`create(SessionCreateParams params)` Creates a Session object.
`static Session`	`create(SessionCreateParams params, RequestOptions options)` Creates a Session object.
`boolean`	`equals(java.lang.Object o)`
`java.lang.Boolean`	`getAllowPromotionCodes()` Enables user redeemable promotion codes.
`java.lang.Long`	`getAmountSubtotal()` Total of all items before discounts or taxes are applied.
`java.lang.Long`	`getAmountTotal()` Total of all items after discounts and taxes are applied.
`java.lang.String`	`getBillingAddressCollection()` Describes whether Checkout should collect the customer's billing address.
`java.lang.String`	`getCancelUrl()` The URL the customer will be directed to if they decide to cancel payment and return to your website.
`java.lang.String`	`getClientReferenceId()` A unique string to reference the Checkout Session.
`java.lang.String`	`getCurrency()` Three-letter ISO currency code, in lowercase.
`java.lang.String`	`getCustomer()` Get ID of expandable `customer` object.
`java.lang.String`	`getCustomerEmail()` If provided, this value will be used when the Customer object is created.
`Customer`	`getCustomerObject()` Get expanded `customer`.
`java.util.List<Session.DisplayItem>`	`getDisplayItems()` The line items, plans, or SKUs purchased by the customer.
`java.lang.String`	`getId()` Unique identifier for the object.
`LineItemCollection`	`getLineItems()` The line items purchased by the customer.
`java.lang.Boolean`	`getLivemode()` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`java.lang.String`	`getLocale()` The IETF language tag of the locale Checkout is displayed in.
`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`	`getMode()` The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`.
`java.lang.String`	`getObject()` String representing the object's type.
`java.lang.String`	`getPaymentIntent()` Get ID of expandable `paymentIntent` object.
`PaymentIntent`	`getPaymentIntentObject()` Get expanded `paymentIntent`.
`java.util.List<java.lang.String>`	`getPaymentMethodTypes()` A list of the types of payment methods (e.g.
`java.lang.String`	`getSetupIntent()` Get ID of expandable `setupIntent` object.
`SetupIntent`	`getSetupIntentObject()` Get expanded `setupIntent`.
`ShippingDetails`	`getShipping()` Shipping information for this Checkout Session.
`Session.ShippingAddressCollection`	`getShippingAddressCollection()` When set, provides configuration for Checkout to collect a shipping address from a customer.
`java.lang.String`	`getSubmitType()` Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button.
`java.lang.String`	`getSubscription()` Get ID of expandable `subscription` object.
`Subscription`	`getSubscriptionObject()` Get expanded `subscription`.
`java.lang.String`	`getSuccessUrl()` The URL the customer will be directed to after the payment or subscription creation is successful.
`Session.TotalDetails`	`getTotalDetails()` Tax and discount details for the computed total amount.
`int`	`hashCode()`
`static SessionCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params)` Returns a list of Checkout Sessions.
`static SessionCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Returns a list of Checkout Sessions.
`static SessionCollection`	`list(SessionListParams params)` Returns a list of Checkout Sessions.
`static SessionCollection`	`list(SessionListParams params, RequestOptions options)` Returns a list of Checkout Sessions.
`LineItemCollection`	`listLineItems(java.util.Map<java.lang.String,java.lang.Object> params)` Returns a list of Line Items
`LineItemCollection`	`listLineItems(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Returns a list of Line Items
`LineItemCollection`	`listLineItems(SessionListLineItemsParams params)` Returns a list of Line Items
`LineItemCollection`	`listLineItems(SessionListLineItemsParams params, RequestOptions options)` Returns a list of Line Items
`static Session`	`retrieve(java.lang.String session)` Retrieves a Session object.
`static Session`	`retrieve(java.lang.String session, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieves a Session object.
`static Session`	`retrieve(java.lang.String session, RequestOptions options)` Retrieves a Session object.
`static Session`	`retrieve(java.lang.String session, SessionRetrieveParams params, RequestOptions options)` Retrieves a Session object.
`void`	`setAllowPromotionCodes(java.lang.Boolean allowPromotionCodes)` Enables user redeemable promotion codes.
`void`	`setAmountSubtotal(java.lang.Long amountSubtotal)` Total of all items before discounts or taxes are applied.
`void`	`setAmountTotal(java.lang.Long amountTotal)` Total of all items after discounts and taxes are applied.
`void`	`setBillingAddressCollection(java.lang.String billingAddressCollection)` Describes whether Checkout should collect the customer's billing address.
`void`	`setCancelUrl(java.lang.String cancelUrl)` The URL the customer will be directed to if they decide to cancel payment and return to your website.
`void`	`setClientReferenceId(java.lang.String clientReferenceId)` A unique string to reference the Checkout Session.
`void`	`setCurrency(java.lang.String currency)` Three-letter ISO currency code, in lowercase.
`void`	`setCustomer(java.lang.String id)`
`void`	`setCustomerEmail(java.lang.String customerEmail)` If provided, this value will be used when the Customer object is created.
`void`	`setCustomerObject(Customer expandableObject)`
`void`	`setDisplayItems(java.util.List<Session.DisplayItem> displayItems)` The line items, plans, or SKUs purchased by the customer.
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setLineItems(LineItemCollection lineItems)` The line items purchased by the customer.
`void`	`setLivemode(java.lang.Boolean livemode)` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`void`	`setLocale(java.lang.String locale)` The IETF language tag of the locale Checkout is displayed in.
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Set of key-value pairs that you can attach to an object.
`void`	`setMode(java.lang.String mode)` The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`.
`void`	`setObject(java.lang.String object)` String representing the object's type.
`void`	`setPaymentIntent(java.lang.String id)`
`void`	`setPaymentIntentObject(PaymentIntent expandableObject)`
`void`	`setPaymentMethodTypes(java.util.List<java.lang.String> paymentMethodTypes)` A list of the types of payment methods (e.g.
`void`	`setSetupIntent(java.lang.String id)`
`void`	`setSetupIntentObject(SetupIntent expandableObject)`
`void`	`setShipping(ShippingDetails shipping)` Shipping information for this Checkout Session.
`void`	`setShippingAddressCollection(Session.ShippingAddressCollection shippingAddressCollection)` When set, provides configuration for Checkout to collect a shipping address from a customer.
`void`	`setSubmitType(java.lang.String submitType)` Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button.
`void`	`setSubscription(java.lang.String id)`
`void`	`setSubscriptionObject(Subscription expandableObject)`
`void`	`setSuccessUrl(java.lang.String successUrl)` The URL the customer will be directed to after the payment or subscription creation is successful.
`void`	`setTotalDetails(Session.TotalDetails totalDetails)` Tax and discount details for the computed total amount.

Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

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

- Constructor Detail
  - Session
```
public Session()
```
- Method Detail
  - getCustomer
```
public java.lang.String getCustomer()
```
    Get ID of expandable customer object.
  - setCustomer
```
public void setCustomer(java.lang.String id)
```
  - getCustomerObject
```
public Customer getCustomerObject()
```
    Get expanded customer.
  - setCustomerObject
```
public void setCustomerObject(Customer expandableObject)
```
  - getPaymentIntent
```
public java.lang.String getPaymentIntent()
```
    Get ID of expandable paymentIntent object.
  - setPaymentIntent
```
public void setPaymentIntent(java.lang.String id)
```
  - getPaymentIntentObject
```
public PaymentIntent getPaymentIntentObject()
```
    Get expanded paymentIntent.
  - setPaymentIntentObject
```
public void setPaymentIntentObject(PaymentIntent expandableObject)
```
  - getSetupIntent
```
public java.lang.String getSetupIntent()
```
    Get ID of expandable setupIntent object.
  - setSetupIntent
```
public void setSetupIntent(java.lang.String id)
```
  - getSetupIntentObject
```
public SetupIntent getSetupIntentObject()
```
    Get expanded setupIntent.
  - setSetupIntentObject
```
public void setSetupIntentObject(SetupIntent expandableObject)
```
  - getSubscription
```
public java.lang.String getSubscription()
```
    Get ID of expandable subscription object.
  - setSubscription
```
public void setSubscription(java.lang.String id)
```
  - getSubscriptionObject
```
public Subscription getSubscriptionObject()
```
    Get expanded subscription.
  - setSubscriptionObject
```
public void setSubscriptionObject(Subscription expandableObject)
```
  - list
```
public static SessionCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                              throws StripeException
```
    Returns a list of Checkout Sessions.
    
    Throws:
    
    StripeException
  - list
```
public static SessionCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                     RequestOptions options)
                              throws StripeException
```
    Returns a list of Checkout Sessions.
    
    Throws:
    
    StripeException
  - list
```
public static SessionCollection list(SessionListParams params)
                              throws StripeException
```
    Returns a list of Checkout Sessions.
    
    Throws:
    
    StripeException
  - list
```
public static SessionCollection list(SessionListParams params,
                                     RequestOptions options)
                              throws StripeException
```
    Returns a list of Checkout Sessions.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Session retrieve(java.lang.String session)
                        throws StripeException
```
    Retrieves a Session object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Session retrieve(java.lang.String session,
                               RequestOptions options)
                        throws StripeException
```
    Retrieves a Session object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Session retrieve(java.lang.String session,
                               java.util.Map<java.lang.String,java.lang.Object> params,
                               RequestOptions options)
                        throws StripeException
```
    Retrieves a Session object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Session retrieve(java.lang.String session,
                               SessionRetrieveParams params,
                               RequestOptions options)
                        throws StripeException
```
    Retrieves a Session object.
    
    Throws:
    
    StripeException
  - create
```
public static Session create(java.util.Map<java.lang.String,java.lang.Object> params)
                      throws StripeException
```
    Creates a Session object.
    
    Throws:
    
    StripeException
  - create
```
public static Session create(java.util.Map<java.lang.String,java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException
```
    Creates a Session object.
    
    Throws:
    
    StripeException
  - create
```
public static Session create(SessionCreateParams params)
                      throws StripeException
```
    Creates a Session object.
    
    Throws:
    
    StripeException
  - create
```
public static Session create(SessionCreateParams params,
                             RequestOptions options)
                      throws StripeException
```
    Creates a Session object.
    
    Throws:
    
    StripeException
  - listLineItems
```
public LineItemCollection listLineItems(java.util.Map<java.lang.String,java.lang.Object> params)
                                 throws StripeException
```
    Returns a list of Line Items
    
    Throws:
    
    StripeException
  - listLineItems
```
public LineItemCollection listLineItems(java.util.Map<java.lang.String,java.lang.Object> params,
                                        RequestOptions options)
                                 throws StripeException
```
    Returns a list of Line Items
    
    Throws:
    
    StripeException
  - listLineItems
```
public LineItemCollection listLineItems(SessionListLineItemsParams params)
                                 throws StripeException
```
    Returns a list of Line Items
    
    Throws:
    
    StripeException
  - listLineItems
```
public LineItemCollection listLineItems(SessionListLineItemsParams params,
                                        RequestOptions options)
                                 throws StripeException
```
    Returns a list of Line Items
    
    Throws:
    
    StripeException
  - getAllowPromotionCodes
```
public java.lang.Boolean getAllowPromotionCodes()
```
    Enables user redeemable promotion codes.
  - getAmountSubtotal
```
public java.lang.Long getAmountSubtotal()
```
    Total of all items before discounts or taxes are applied.
  - getAmountTotal
```
public java.lang.Long getAmountTotal()
```
    Total of all items after discounts and taxes are applied.
  - getBillingAddressCollection
```
public java.lang.String getBillingAddressCollection()
```
    Describes whether Checkout should collect the customer's billing address.
    One of auto, or required.
  - getCancelUrl
```
public java.lang.String getCancelUrl()
```
    The URL the customer will be directed to if they decide to cancel payment and return to your website.
  - getClientReferenceId
```
public java.lang.String getClientReferenceId()
```
    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.
  - getCurrency
```
public java.lang.String getCurrency()
```
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
  - getCustomerEmail
```
public java.lang.String getCustomerEmail()
```
    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 attribute.
  - getDisplayItems
```
public java.util.List<Session.DisplayItem> getDisplayItems()
```
    The line items, plans, or SKUs purchased by the customer. Prefer using line_items.
  - getLineItems
```
public LineItemCollection getLineItems()
```
    The line items purchased by the customer.
  - getLivemode
```
public java.lang.Boolean getLivemode()
```
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  - getLocale
```
public java.lang.String getLocale()
```
    The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.
    One of auto, bg, cs, da, de, el, en, en-GB, es, es-419, et, fi, fr, fr-CA, hu, id, it, ja, lt, lv, ms, mt, nb, nl, pl, pt, pt-BR, ro, ru, sk, sl, sv, tr, zh, zh-HK, or zh-TW.
  - 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.
  - getMode
```
public java.lang.String getMode()
```
    The mode of the Checkout Session, one of payment, setup, or subscription.
  - getObject
```
public java.lang.String getObject()
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to checkout.session.
  - getPaymentMethodTypes
```
public java.util.List<java.lang.String> getPaymentMethodTypes()
```
    A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.
  - getShipping
```
public ShippingDetails getShipping()
```
    Shipping information for this Checkout Session.
  - getShippingAddressCollection
```
public Session.ShippingAddressCollection getShippingAddressCollection()
```
    When set, provides configuration for Checkout to collect a shipping address from a customer.
  - getSubmitType
```
public java.lang.String getSubmitType()
```
    Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. submit_type can only be specified on Checkout Sessions in payment mode, but not Checkout Sessions in subscription or setup mode.
    One of auto, book, donate, or pay.
  - getSuccessUrl
```
public java.lang.String getSuccessUrl()
```
    The URL the customer will be directed to after the payment or subscription creation is successful.
  - getTotalDetails
```
public Session.TotalDetails getTotalDetails()
```
    Tax and discount details for the computed total amount.
  - setAllowPromotionCodes
```
public void setAllowPromotionCodes(java.lang.Boolean allowPromotionCodes)
```
    Enables user redeemable promotion codes.
  - setAmountSubtotal
```
public void setAmountSubtotal(java.lang.Long amountSubtotal)
```
    Total of all items before discounts or taxes are applied.
  - setAmountTotal
```
public void setAmountTotal(java.lang.Long amountTotal)
```
    Total of all items after discounts and taxes are applied.
  - setBillingAddressCollection
```
public void setBillingAddressCollection(java.lang.String billingAddressCollection)
```
    Describes whether Checkout should collect the customer's billing address.
    One of auto, or required.
  - setCancelUrl
```
public void 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 void 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.
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
  - setCustomerEmail
```
public void 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 attribute.
  - setDisplayItems
```
public void setDisplayItems(java.util.List<Session.DisplayItem> displayItems)
```
    The line items, plans, or SKUs purchased by the customer. Prefer using line_items.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier for the object. Used to pass to redirectToCheckout in Stripe.js.
  - setLineItems
```
public void setLineItems(LineItemCollection lineItems)
```
    The line items purchased by the customer.
  - setLivemode
```
public void setLivemode(java.lang.Boolean livemode)
```
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  - setLocale
```
public void setLocale(java.lang.String locale)
```
    The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.
    One of auto, bg, cs, da, de, el, en, en-GB, es, es-419, et, fi, fr, fr-CA, hu, id, it, ja, lt, lv, ms, mt, nb, nl, pl, pt, pt-BR, ro, ru, sk, sl, sv, tr, zh, zh-HK, or zh-TW.
  - setMetadata
```
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
```
    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.
  - setMode
```
public void setMode(java.lang.String mode)
```
    The mode of the Checkout Session, one of payment, setup, or subscription.
  - setObject
```
public void setObject(java.lang.String object)
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to checkout.session.
  - setPaymentMethodTypes
```
public void setPaymentMethodTypes(java.util.List<java.lang.String> paymentMethodTypes)
```
    A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.
  - setShipping
```
public void setShipping(ShippingDetails shipping)
```
    Shipping information for this Checkout Session.
  - setShippingAddressCollection
```
public void setShippingAddressCollection(Session.ShippingAddressCollection shippingAddressCollection)
```
    When set, provides configuration for Checkout to collect a shipping address from a customer.
  - setSubmitType
```
public void setSubmitType(java.lang.String submitType)
```
    Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. submit_type can only be specified on Checkout Sessions in payment mode, but not Checkout Sessions in subscription or setup mode.
    One of auto, book, donate, or pay.
  - setSuccessUrl
```
public void setSuccessUrl(java.lang.String successUrl)
```
    The URL the customer will be directed to after the payment or subscription creation is successful.
  - setTotalDetails
```
public void setTotalDetails(Session.TotalDetails totalDetails)
```
    Tax and discount details for the computed total amount.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public java.lang.String getId()
```
    Unique identifier for the object. Used to pass to redirectToCheckout in Stripe.js.
    
    Specified by:
    
    getId in interface HasId

Class Session

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

Field Summary

Fields inherited from class com.stripe.net.ApiResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.ApiResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Session

Method Detail

getCustomer

setCustomer

getCustomerObject

setCustomerObject

getPaymentIntent

setPaymentIntent

getPaymentIntentObject

setPaymentIntentObject

getSetupIntent

setSetupIntent

getSetupIntentObject

setSetupIntentObject

getSubscription

setSubscription

getSubscriptionObject

setSubscriptionObject

list

list

list

list

retrieve

retrieve

retrieve

retrieve

create

create

create

create

listLineItems

listLineItems

listLineItems

listLineItems

getAllowPromotionCodes

getAmountSubtotal

getAmountTotal

getBillingAddressCollection

getCancelUrl

getClientReferenceId

getCurrency

getCustomerEmail

getDisplayItems

getLineItems

getLivemode

getLocale

getMetadata

getMode

getObject

getPaymentMethodTypes

getShipping

getShippingAddressCollection

getSubmitType

getSuccessUrl

getTotalDetails

setAllowPromotionCodes

setAmountSubtotal

setAmountTotal

setBillingAddressCollection

setCancelUrl

setClientReferenceId

setCurrency

setCustomerEmail

setDisplayItems

setId

setLineItems

setLivemode

setLocale