Package com.stripe.model.billingportal

Class Session

    • Constructor Detail

      • Session

        public Session()

    • Method Detail

      • getConfiguration

        public java.lang.String getConfiguration()
        Get ID of expandable configuration object.

      • setConfiguration

        public void setConfiguration​(java.lang.String id)

      • getConfigurationObject

        public Configuration getConfigurationObject()
        Get expanded configuration.

      • setConfigurationObject

        public void setConfigurationObject​(Configuration expandableObject)

      • create

        public static Session create​(java.util.Map<java.lang.String,​java.lang.Object> params)
                      throws StripeException
        Creates a session of the customer portal.
        Throws:
        StripeException

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getCustomer

        public java.lang.String getCustomer()
        The ID of the customer for this 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.

      • getLocale

        public java.lang.String getLocale()
        The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.

        One of auto, bg, cs, da, de, el, en, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-SG, es, es-419, et, fi, fil, fr, fr-CA, hr, hu, id, it, ja, ko, lt, lv, ms, mt, nb, nl, pl, pt, pt-BR, ro, ru, sk, sl, sv, th, tr, vi, zh, zh-HK, or zh-TW.

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

      • getOnBehalfOf

        public java.lang.String getOnBehalfOf()
        The account for which the session was created on behalf of. 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 URL to redirect customers to when they click on the portal's link to return to your website.

      • getUrl

        public java.lang.String getUrl()
        The short-lived URL of the session that gives customers access to the customer portal.

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setCustomer

        public void setCustomer​(java.lang.String customer)
        The ID of the customer for this session.

      • setId

        public void setId​(java.lang.String id)
        Unique identifier for the object.

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

      • setLocale

        public void setLocale​(java.lang.String locale)
        The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.

        One of auto, bg, cs, da, de, el, en, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-SG, es, es-419, et, fi, fil, fr, fr-CA, hr, hu, id, it, ja, ko, lt, lv, ms, mt, nb, nl, pl, pt, pt-BR, ro, ru, sk, sl, sv, th, tr, vi, zh, zh-HK, or zh-TW.

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

      • setOnBehalfOf

        public void setOnBehalfOf​(java.lang.String onBehalfOf)
        The account for which the session was created on behalf of. 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.

      • setReturnUrl

        public void setReturnUrl​(java.lang.String returnUrl)
        The URL to redirect customers to when they click on the portal's link to return to your website.

      • setUrl

        public void setUrl​(java.lang.String url)
        The short-lived URL of the session that gives customers access to the customer portal.

      • 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