Package com.stripe.param.billingportal

Class SessionCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.billingportal.SessionCreateParams

public class SessionCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionCreateParams.Builder
static class	SessionCreateParams.FlowData
static enum	SessionCreateParams.Locale

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 SessionCreateParams.Builder	builder()
String	getConfiguration()	The ID of an existing configuration to use for this session, describing its functionality and features.
String	getCustomer()	Required. The ID of an existing customer.
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.
SessionCreateParams.FlowData	getFlowData()	Information about a specific flow for the customer to go through.
SessionCreateParams.Locale	getLocale()	The IETF language tag of the locale customer portal is displayed in.
String	getOnBehalfOf()	The on_behalf_of account to use for this session.
String	getReturnUrl()	The default URL to redirect customers to when they click on the portal's link to return to your website.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SessionCreateParams.Builder builder()

getConfiguration

public String getConfiguration()

The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.

getCustomer

public String getCustomer()

Required. The ID of an existing customer.

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.

getFlowData

public SessionCreateParams.FlowData getFlowData()

Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows.

getLocale

public SessionCreateParams.Locale getLocale()

The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.

getOnBehalfOf

public String getOnBehalfOf()

The on_behalf_of account to use for this session. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays.

getReturnUrl

public String getReturnUrl()

The default URL to redirect customers to when they click on the portal's link to return to your website.