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
,StripeObjectInterface
public class Configuration extends ApiResource implements HasId
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Configuration.BusinessProfile
static class
Configuration.Features
-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description Configuration()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(java.lang.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(java.util.Map<java.lang.String,java.lang.Object> params)
Creates a configuration that describes the functionality and behavior of a PortalSession.static Configuration
create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Creates a configuration that describes the functionality and behavior of a PortalSession.boolean
equals(java.lang.Object o)
java.lang.Boolean
getActive()
Whether the configuration is active and can be used to create portal sessions.java.lang.String
getApplication()
ID of the Connect Application that created the configuration.Configuration.BusinessProfile
getBusinessProfile()
java.lang.Long
getCreated()
Time at which the object was created.java.lang.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()
java.lang.String
getId()
Unique identifier for the object.java.lang.Boolean
getIsDefault()
Whether the configuration is the default.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.java.lang.String
getObject()
String representing the object's type.java.lang.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(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of configurations that describe the functionality of the customer portal.static ConfigurationCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list of configurations that describe the functionality of the customer portal.static Configuration
retrieve(java.lang.String configuration)
Retrieves a configuration that describes the functionality of the customer portal.static Configuration
retrieve(java.lang.String configuration, RequestOptions options)
Retrieves a configuration that describes the functionality of the customer portal.static Configuration
retrieve(java.lang.String configuration, ConfigurationRetrieveParams params, RequestOptions options)
Retrieves a configuration that describes the functionality of the customer portal.static Configuration
retrieve(java.lang.String configuration, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves a configuration that describes the functionality of the customer portal.void
setActive(java.lang.Boolean active)
Whether the configuration is active and can be used to create portal sessions.void
setApplication(java.lang.String application)
ID of the Connect Application that created the configuration.void
setBusinessProfile(Configuration.BusinessProfile businessProfile)
void
setCreated(java.lang.Long created)
Time at which the object was created.void
setDefaultReturnUrl(java.lang.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(java.lang.String id)
Unique identifier for the object.void
setIsDefault(java.lang.Boolean isDefault)
Whether the configuration is the default.void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setObject(java.lang.String object)
String representing the object's type.void
setUpdated(java.lang.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(java.util.Map<java.lang.String,java.lang.Object> params)
Updates a configuration that describes the functionality of the customer portal.Configuration
update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Updates a configuration that describes the functionality of the customer portal.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
-
-
-
Method Detail
-
list
public static ConfigurationCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of configurations that describe the functionality of the customer portal.- Throws:
StripeException
-
list
public static ConfigurationCollection list(java.util.Map<java.lang.String,java.lang.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
-
create
public static Configuration create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Creates a configuration that describes the functionality and behavior of a PortalSession.- Throws:
StripeException
-
create
public static Configuration create(java.util.Map<java.lang.String,java.lang.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
-
update
public Configuration update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates a configuration that describes the functionality of the customer portal.- Throws:
StripeException
-
update
public Configuration update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates a configuration that describes the functionality of the customer portal.- 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
-
retrieve
public static Configuration retrieve(java.lang.String configuration) throws StripeException
Retrieves a configuration that describes the functionality of the customer portal.- Throws:
StripeException
-
retrieve
public static Configuration retrieve(java.lang.String configuration, RequestOptions options) throws StripeException
Retrieves a configuration that describes the functionality of the customer portal.- Throws:
StripeException
-
retrieve
public static Configuration retrieve(java.lang.String configuration, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves a configuration that describes the functionality of the customer portal.- Throws:
StripeException
-
retrieve
public static Configuration retrieve(java.lang.String configuration, ConfigurationRetrieveParams params, RequestOptions options) throws StripeException
Retrieves a configuration that describes the functionality of the customer portal.- Throws:
StripeException
-
getActive
public java.lang.Boolean getActive()
Whether the configuration is active and can be used to create portal sessions.
-
getApplication
public java.lang.String getApplication()
ID of the Connect Application that created the configuration.
-
getBusinessProfile
public Configuration.BusinessProfile getBusinessProfile()
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getDefaultReturnUrl
public java.lang.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 java.lang.Boolean getIsDefault()
Whether the configuration is the default. Iftrue
, 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 java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
billing_portal.configuration
.
-
getUpdated
public java.lang.Long getUpdated()
Time at which the object was last updated. Measured in seconds since the Unix epoch.
-
setActive
public void setActive(java.lang.Boolean active)
Whether the configuration is active and can be used to create portal sessions.
-
setApplication
public void setApplication(java.lang.String application)
ID of the Connect Application that created the configuration.
-
setBusinessProfile
public void setBusinessProfile(Configuration.BusinessProfile businessProfile)
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setDefaultReturnUrl
public void setDefaultReturnUrl(java.lang.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(java.lang.String id)
Unique identifier for the object.
-
setIsDefault
public void setIsDefault(java.lang.Boolean isDefault)
Whether the configuration is the default. Iftrue
, 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(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
setObject
public void setObject(java.lang.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(java.lang.Long updated)
Time at which the object was last updated. Measured in seconds since the Unix epoch.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-