Package com.stripe.param.checkout

Class SessionUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.checkout.SessionUpdateParams

public class SessionUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionUpdateParams.AutomaticTax
static class	SessionUpdateParams.Builder
static class	SessionUpdateParams.CollectedInformation	Required. Type of the account referenced in the request.
static class	SessionUpdateParams.Discount	State, county, province, or region.
static class	SessionUpdateParams.InvoiceCreation	A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amount_off is not passed).
static class	SessionUpdateParams.LineItem	Required. Type of the account referenced in the request.
static class	SessionUpdateParams.ShippingOption	The number of intervals between subscription billings.
static class	SessionUpdateParams.SubscriptionData	Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.

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

Modifier and Type	Method	Description
static SessionUpdateParams.Builder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SessionUpdateParams.AutomaticTax	getAutomaticTax()	Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
SessionUpdateParams.CollectedInformation	getCollectedInformation()	Information about the customer collected within the Checkout Session.
Object	getDiscounts()	List of coupons and promotion codes attached to the Checkout Session.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
SessionUpdateParams.InvoiceCreation	getInvoiceCreation()	Generate a post-purchase Invoice for one-time payments.
List<SessionUpdateParams.LineItem>	getLineItems()	A list of items the customer is purchasing.
Object	getMetadata()	Set of key-value pairs that you can attach to an object.
Object	getShippingOptions()	The shipping rate options to apply to this Session.
SessionUpdateParams.SubscriptionData	getSubscriptionData()	A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription mode.
int	hashCode()

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SessionUpdateParams.Builder builder()

getAutomaticTax

public SessionUpdateParams.AutomaticTax getAutomaticTax()

Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.

getCollectedInformation

public SessionUpdateParams.CollectedInformation getCollectedInformation()

Information about the customer collected within the Checkout Session. Can only be set when updating embedded or custom sessions.

getDiscounts

public Object getDiscounts()

List of coupons and promotion codes attached to the Checkout Session.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

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.

getInvoiceCreation

public SessionUpdateParams.InvoiceCreation getInvoiceCreation()

Generate a post-purchase Invoice for one-time payments.

getLineItems

public List<SessionUpdateParams.LineItem> getLineItems()

A list of items the customer is purchasing.

When updating line items, you must retransmit the entire array of line items.

To retain an existing line item, specify its id.

To update an existing line item, specify its id along with the new values of the fields to update.

To add a new line item, specify one of price or price_data and quantity.

To remove an existing line item, omit the line item's ID from the retransmitted array.

To reorder a line item, specify it at the desired position in the retransmitted array.

getMetadata

public Object 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 to metadata.

getShippingOptions

public Object getShippingOptions()

The shipping rate options to apply to this Session. Up to a maximum of 5.

getSubscriptionData

public SessionUpdateParams.SubscriptionData getSubscriptionData()

A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription mode.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object