Package com.stripe.model.billingportal

Class Configuration

    • Constructor Detail

      • Configuration

        public Configuration()

    • Method Detail

      • 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

      • 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,
                                     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

      • 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.

      • 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.

      • getIsDefault

        public java.lang.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 java.lang.Boolean getLivemode()
        Has the value true if the object exists in live mode or the value false 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.

      • 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.

      • 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. 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​(java.lang.Boolean livemode)
        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • setMetadata

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

      • 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 class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId

      • getMetadata

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