class

Stripe::BillingPortalConfiguration

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A portal configuration describes the functionality and behavior of a portal session.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [billing_portal.configuration]."
MAX_LENGTH_FOR_DEFAULT_RETURN_URL = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("billing_portal.configuration")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, active : Bool | Nil = nil, application : Stripe::BillingPortalConfigurationApplication | Nil = nil, business_profile : Stripe::PortalBusinessProfile | Nil = nil, created : Int64 | Nil = nil, default_return_url : String | Nil = nil, features : Stripe::PortalFeatures | Nil = nil, id : String | Nil = nil, is_default : Bool | Nil = nil, livemode : Bool | Nil = nil, login_page : Stripe::PortalLoginPage | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, updated : Int64 | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

active

Whether the configuration is active and can be used to create portal sessions.

Source
active=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] active Object to be assigned

Source
application
Source
application=(new_value : Stripe::BillingPortalConfigurationApplication | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] application Object to be assigned

Source
business_profile
Source
business_profile=(new_value : Stripe::PortalBusinessProfile | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] business_profile Object to be assigned

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
default_return_url

The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.

Source
default_return_url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] default_return_url Object to be assigned

Source
features
Source
features=(new_value : Stripe::PortalFeatures | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] features Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
is_default

Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.

Source
is_default=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] is_default Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
login_page
Source
login_page=(new_value : Stripe::PortalLoginPage | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] login_page Object to be assigned

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
updated

Time at which the object was last updated. Measured in seconds since the Unix epoch.

Source
updated=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] updated Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source