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

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()
java.lang.String	getConfiguration()	The ID of an existing configuration to use for this session, describing its functionality and features.
java.lang.String	getCustomer()	The ID of an existing customer.
java.util.List<java.lang.String>	getExpand()	Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
java.lang.String	getOnBehalfOf()	The on_behalf_of account to use for this session.
java.lang.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

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SessionCreateParams.Builder builder()

getConfiguration

public java.lang.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 java.lang.String getCustomer()

The ID of an existing customer.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.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.

getOnBehalfOf

public java.lang.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 java.lang.String getReturnUrl()

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