Package com.stripe.model.billingportal

Class Configuration

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.billingportal.Configuration

All Implemented Interfaces:

HasId, MetadataStore<Configuration>, StripeActiveObject, StripeObjectInterface

public class Configuration
extends ApiResource
implements HasId, MetadataStore<Configuration>

A portal configuration describes the functionality and behavior of a portal session.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Configuration.BusinessProfile	For more details about BusinessProfile, please refer to the API Reference.
static class	Configuration.Features	For more details about Features, please refer to the API Reference.
static class	Configuration.LoginPage	For more details about LoginPage, please refer to the API Reference.

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

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Configuration()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Configuration	create(ConfigurationCreateParams params)	Creates a configuration that describes the functionality and behavior of a PortalSession.
static Configuration	create(ConfigurationCreateParams params, RequestOptions options)	Creates a configuration that describes the functionality and behavior of a PortalSession.
static Configuration	create(Map<String,Object> params)	Creates a configuration that describes the functionality and behavior of a PortalSession.
static Configuration	create(Map<String,Object> params, RequestOptions options)	Creates a configuration that describes the functionality and behavior of a PortalSession.
boolean	equals(Object o)
Boolean	getActive()	Whether the configuration is active and can be used to create portal sessions.
String	getApplication()	Get ID of expandable application object.
Application	getApplicationObject()	Get expanded application.
Configuration.BusinessProfile	getBusinessProfile()
Long	getCreated()	Time at which the object was created.
String	getDefaultReturnUrl()	The default URL to redirect customers to when they click on the portal's link to return to your website.
Configuration.Features	getFeatures()
String	getId()	Unique identifier for the object.
Boolean	getIsDefault()	Whether the configuration is the default.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Configuration.LoginPage	getLoginPage()
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getName()	The name of the configuration.
String	getObject()	String representing the object's type.
Long	getUpdated()	Time at which the object was last updated.
int	hashCode()
static ConfigurationCollection	list(ConfigurationListParams params)	Returns a list of configurations that describe the functionality of the customer portal.
static ConfigurationCollection	list(ConfigurationListParams params, RequestOptions options)	Returns a list of configurations that describe the functionality of the customer portal.
static ConfigurationCollection	list(Map<String,Object> params)	Returns a list of configurations that describe the functionality of the customer portal.
static ConfigurationCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of configurations that describe the functionality of the customer portal.
static Configuration	retrieve(String configuration)	Retrieves a configuration that describes the functionality of the customer portal.
static Configuration	retrieve(String configuration, RequestOptions options)	Retrieves a configuration that describes the functionality of the customer portal.
static Configuration	retrieve(String configuration, ConfigurationRetrieveParams params, RequestOptions options)	Retrieves a configuration that describes the functionality of the customer portal.
static Configuration	retrieve(String configuration, Map<String,Object> params, RequestOptions options)	Retrieves a configuration that describes the functionality of the customer portal.
void	setActive(Boolean active)	Whether the configuration is active and can be used to create portal sessions.
void	setApplication(String id)
void	setApplicationObject(Application expandableObject)
void	setBusinessProfile(Configuration.BusinessProfile businessProfile)
void	setCreated(Long created)	Time at which the object was created.
void	setDefaultReturnUrl(String defaultReturnUrl)	The default URL to redirect customers to when they click on the portal's link to return to your website.
void	setFeatures(Configuration.Features features)
void	setId(String id)	Unique identifier for the object.
void	setIsDefault(Boolean isDefault)	Whether the configuration is the default.
void	setLivemode(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	setLoginPage(Configuration.LoginPage loginPage)
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setName(String name)	The name of the configuration.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setUpdated(Long updated)	Time at which the object was last updated.
Configuration	update(ConfigurationUpdateParams params)	Updates a configuration that describes the functionality of the customer portal.
Configuration	update(ConfigurationUpdateParams params, RequestOptions options)	Updates a configuration that describes the functionality of the customer portal.
Configuration	update(Map<String,Object> params)	Updates a configuration that describes the functionality of the customer portal.
Configuration	update(Map<String,Object> params, RequestOptions options)	Updates a configuration that describes the functionality of the customer portal.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

Configuration

public Configuration()

Method Details

getApplication

public String getApplication()

Get ID of expandable application object.

setApplication

public void setApplication(String id)

getApplicationObject

public Application getApplicationObject()

Get expanded application.

setApplicationObject

public void setApplicationObject(Application expandableObject)

create

public static Configuration create(Map<String,Object> params)
                            throws StripeException

Creates a configuration that describes the functionality and behavior of a PortalSession.

Throws:

StripeException

create

public static Configuration create(Map<String,Object> params,
 RequestOptions options)
                            throws StripeException

Creates a configuration that describes the functionality and behavior of a PortalSession.

Throws:

StripeException

create

public static Configuration create(ConfigurationCreateParams params)
                            throws StripeException

Creates a configuration that describes the functionality and behavior of a PortalSession.

Throws:

StripeException

create

public static Configuration create(ConfigurationCreateParams params,
 RequestOptions options)
                            throws StripeException

Creates a configuration that describes the functionality and behavior of a PortalSession.

Throws:

StripeException

list

public static ConfigurationCollection list(Map<String,Object> params)
                                    throws StripeException

Returns a list of configurations that describe the functionality of the customer portal.

Throws:

StripeException

list

public static ConfigurationCollection list(Map<String,Object> params,
 RequestOptions options)
                                    throws StripeException

Returns a list of configurations that describe the functionality of the customer portal.

Throws:

StripeException

list

public static ConfigurationCollection list(ConfigurationListParams params)
                                    throws StripeException

Returns a list of configurations that describe the functionality of the customer portal.

Throws:

StripeException

list

public static ConfigurationCollection list(ConfigurationListParams params,
 RequestOptions options)
                                    throws StripeException

Returns a list of configurations that describe the functionality of the customer portal.

Throws:

StripeException

retrieve

public static Configuration retrieve(String configuration)
                              throws StripeException

Retrieves a configuration that describes the functionality of the customer portal.

Throws:

StripeException

retrieve

public static Configuration retrieve(String configuration,
 RequestOptions options)
                              throws StripeException

Retrieves a configuration that describes the functionality of the customer portal.

Throws:

StripeException

retrieve

public static Configuration retrieve(String configuration,
 Map<String,Object> params,
 RequestOptions options)
                              throws StripeException

Retrieves a configuration that describes the functionality of the customer portal.

Throws:

StripeException

retrieve

public static Configuration retrieve(String configuration,
 ConfigurationRetrieveParams params,
 RequestOptions options)
                              throws StripeException

Retrieves a configuration that describes the functionality of the customer portal.

Throws:

StripeException

update

public Configuration update(Map<String,Object> params)
                     throws StripeException

Updates a configuration that describes the functionality of the customer portal.

Specified by:

update in interface MetadataStore<Configuration>

Throws:

StripeException

update

public Configuration update(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Updates a configuration that describes the functionality of the customer portal.

Specified by:

update in interface MetadataStore<Configuration>

Throws:

StripeException

update

public Configuration update(ConfigurationUpdateParams params)
                     throws StripeException

Updates a configuration that describes the functionality of the customer portal.

Throws:

StripeException

update

public Configuration update(ConfigurationUpdateParams params,
 RequestOptions options)
                     throws StripeException

Updates a configuration that describes the functionality of the customer portal.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getActive

public Boolean getActive()

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

getBusinessProfile

public Configuration.BusinessProfile getBusinessProfile()

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getDefaultReturnUrl

public String 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.

getFeatures

public Configuration.Features getFeatures()

getIsDefault

public Boolean getIsDefault()

Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getLoginPage

public Configuration.LoginPage getLoginPage()

getName

public String getName()

The name of the configuration.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to billing_portal.configuration.

getUpdated

public Long getUpdated()

Time at which the object was last updated. Measured in seconds since the Unix epoch.

setActive

public void setActive(Boolean active)

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

setBusinessProfile

public void setBusinessProfile(Configuration.BusinessProfile businessProfile)

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setDefaultReturnUrl

public void setDefaultReturnUrl(String defaultReturnUrl)

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.

setFeatures

public void setFeatures(Configuration.Features features)

setId

public void setId(String id)

Unique identifier for the object.

setIsDefault

public void setIsDefault(Boolean isDefault)

Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setLoginPage

public void setLoginPage(Configuration.LoginPage loginPage)

setMetadata

public void setMetadata(Map<String,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.

setName

public void setName(String name)

The name of the configuration.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to billing_portal.configuration.

setUpdated

public void setUpdated(Long updated)

Time at which the object was last updated. Measured in seconds since the Unix epoch.

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

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

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

Specified by:

getMetadata in interface MetadataStore<Configuration>