Class SessionCreateParams

    • Method Detail

      • getConfiguration

        public java.lang.String getConfiguration()
        The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
      • getCustomer

        public java.lang.String getCustomer()
        The ID of an existing customer.
      • getExpand

        public java.util.List<java.lang.String> getExpand()
        Specifies which fields in the response should be expanded.
      • getExtraParams

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

        public SessionCreateParams.Locale 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.
      • getOnBehalfOf

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