Package com.stripe.param.billingportal

Class SessionCreateParams.Builder

java.lang.Object
com.stripe.param.billingportal.SessionCreateParams.Builder
Enclosing class:
SessionCreateParams
public static class SessionCreateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public SessionCreateParams build()
      Finalize and obtain parameter instance from this builder.

    • setConfiguration

      public SessionCreateParams.Builder setConfiguration(String configuration)
      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.

    • setCustomer

      public SessionCreateParams.Builder setCustomer(String customer)
      Required. The ID of an existing customer.

    • addExpand

      public SessionCreateParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SessionCreateParams.expand for the field documentation.

    • addAllExpand

      public SessionCreateParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SessionCreateParams.expand for the field documentation.

    • putExtraParam

      public SessionCreateParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SessionCreateParams.extraParams for the field documentation.

    • putAllExtraParam

      public SessionCreateParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SessionCreateParams.extraParams for the field documentation.

    • setFlowData

      public SessionCreateParams.Builder setFlowData(SessionCreateParams.FlowData flowData)
      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.

    • setLocale

      public SessionCreateParams.Builder setLocale(SessionCreateParams.Locale 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.

    • setOnBehalfOf

      public SessionCreateParams.Builder setOnBehalfOf(String onBehalfOf)
      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.

    • setReturnUrl

      public SessionCreateParams.Builder setReturnUrl(String returnUrl)
      The default URL to redirect customers to when they click on the portal's link to return to your website.