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 java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SessionCreateParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.SessionCreateParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.SessionCreateParams
build()
Finalize and obtain parameter instance from this builder.SessionCreateParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.SessionCreateParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.SessionCreateParams.Builder
setConfiguration(java.lang.String configuration)
The ID of an existing configuration to use for this session, describing its functionality and features.SessionCreateParams.Builder
setCustomer(java.lang.String customer)
The ID of an existing customer.SessionCreateParams.Builder
setLocale(SessionCreateParams.Locale locale)
The IETF language tag of the locale Customer Portal is displayed in.SessionCreateParams.Builder
setOnBehalfOf(java.lang.String onBehalfOf)
Theon_behalf_of
account to use for this session.SessionCreateParams.Builder
setReturnUrl(java.lang.String returnUrl)
The default URL to redirect customers to when they click on the portal's link to return to your website.
-
-
-
Method Detail
-
build
public SessionCreateParams build()
Finalize and obtain parameter instance from this builder.
-
setConfiguration
public SessionCreateParams.Builder setConfiguration(java.lang.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(java.lang.String customer)
The ID of an existing customer.
-
addExpand
public SessionCreateParams.Builder addExpand(java.lang.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. SeeSessionCreateParams.expand
for the field documentation.
-
addAllExpand
public SessionCreateParams.Builder addAllExpand(java.util.List<java.lang.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. SeeSessionCreateParams.expand
for the field documentation.
-
putExtraParam
public SessionCreateParams.Builder putExtraParam(java.lang.String key, java.lang.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. SeeSessionCreateParams.extraParams
for the field documentation.
-
putAllExtraParam
public SessionCreateParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.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. SeeSessionCreateParams.extraParams
for the field documentation.
-
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’spreferred_locales
or browser’s locale is used.
-
setOnBehalfOf
public SessionCreateParams.Builder setOnBehalfOf(java.lang.String onBehalfOf)
Theon_behalf_of
account to use for this session. When specified, only subscriptions and invoices with thison_behalf_of
account appear in the portal. For more information, see the docs. Use the Accounts API to modify theon_behalf_of
account's branding settings, which the portal displays.
-
setReturnUrl
public SessionCreateParams.Builder setReturnUrl(java.lang.String returnUrl)
The default URL to redirect customers to when they click on the portal's link to return to your website.
-
-