class Stripe::BillingPortalConfiguration

• Stripe::BillingPortalConfiguration
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

stripe/models/billing_portal_configuration.cr

Constant Summary

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)
• .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

Instance Method Summary

• #==(other : self)

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

• #active : Bool | Nil
• #active=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #application : Stripe::BillingPortalConfigurationApplication | Nil
• #application=(new_value : Stripe::BillingPortalConfigurationApplication | Nil)

  Custom attribute writer method checking allowed values (enum).

• #business_profile : Stripe::PortalBusinessProfile | Nil
• #business_profile=(new_value : Stripe::PortalBusinessProfile | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #default_return_url : String | Nil
• #default_return_url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #features : Stripe::PortalFeatures | Nil
• #features=(new_value : Stripe::PortalFeatures | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #is_default : Bool | Nil
• #is_default=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #login_page : Stripe::PortalLoginPage | Nil
• #login_page=(new_value : Stripe::PortalLoginPage | Nil)

  Custom attribute writer method checking allowed values (enum).

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #updated : Int64 | Nil
• #updated=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail