Package com.stripe.param.billingportal

Class ConfigurationUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.billingportal.ConfigurationUpdateParams

public class ConfigurationUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigurationUpdateParams.Builder
static class	ConfigurationUpdateParams.BusinessProfile
static class	ConfigurationUpdateParams.Features	A link to the business’s publicly available terms of service.
static class	ConfigurationUpdateParams.LoginPage	Required. The product id.

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 ConfigurationUpdateParams.Builder	builder()
Boolean	getActive()	Whether the configuration is active and can be used to create portal sessions.
ConfigurationUpdateParams.BusinessProfile	getBusinessProfile()	The business information shown to customers in the portal.
Object	getDefaultReturnUrl()	The default URL to redirect customers to when they click on the portal's link to return to your website.
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.
ConfigurationUpdateParams.Features	getFeatures()	Information about the features available in the portal.
ConfigurationUpdateParams.LoginPage	getLoginPage()	The hosted login page for this configuration.
Object	getMetadata()	Set of key-value pairs that you can attach to an object.

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 ConfigurationUpdateParams.Builder builder()

getActive

public Boolean getActive()

Whether the configuration is active and can be used to create portal sessions.

getBusinessProfile

public ConfigurationUpdateParams.BusinessProfile getBusinessProfile()

The business information shown to customers in the portal.

getDefaultReturnUrl

public Object getDefaultReturnUrl()

The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the 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.

getFeatures

public ConfigurationUpdateParams.Features getFeatures()

Information about the features available in the portal.

getLoginPage

public ConfigurationUpdateParams.LoginPage getLoginPage()

The hosted login page for this configuration. Learn more about the portal login page in our integration docs.

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.