Class SessionCreateParams


public class SessionCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static SessionCreateParams.Builder builder()
    • getConfiguration

      public 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 String getCustomer()
      Required. The ID of an existing customer.
    • getExpand

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

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

      public SessionCreateParams.FlowData getFlowData()
      Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows.
    • 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 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 String getReturnUrl()
      The default URL to redirect customers to when they click on the portal's link to return to your website.