class

Stripe::BillingPortalSession

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

The Billing customer portal is a Stripe-hosted UI for subscription and billing management. A portal configuration describes the functionality and features that you want to provide to your customers through the portal. A portal session describes the instantiation of the customer portal for a particular customer. By visiting the session's URL, the customer can manage their subscriptions and billing details. For security reasons, sessions are short-lived and will expire if the customer does not visit the URL. Create sessions on-demand when customers intend to manage their subscriptions and billing details. Related guide: Customer management

Constants

ERROR_MESSAGE_FOR_LOCALE = "invalid value for \"locale\", must be one of [auto, bg, cs, da, de, el, en, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-SG, es, es-419, et, fi, fil, fr, fr-CA, hr, hu, id, it, ja, ko, lt, lv, ms, mt, nb, nl, pl, pt, pt-BR, ro, ru, sk, sl, sv, th, tr, vi, zh, zh-HK, zh-TW]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [billing_portal.session]."
MAX_LENGTH_FOR_CUSTOMER = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_ON_BEHALF_OF = 5000
MAX_LENGTH_FOR_RETURN_URL = 5000
MAX_LENGTH_FOR_URL = 5000
VALID_VALUES_FOR_LOCALE = String.static_array("auto", "bg", "cs", "da", "de", "el", "en", "en-AU", "en-CA", "en-GB", "en-IE", "en-IN", "en-NZ", "en-SG", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW")
VALID_VALUES_FOR_OBJECT = String.static_array("billing_portal.session")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, configuration : Stripe::BillingPortalSessionConfiguration | Nil = nil, created : Int64 | Nil = nil, customer : String | Nil = nil, flow : Stripe::BillingPortalSessionFlow | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, locale : String | Nil = nil, object : String | Nil = nil, on_behalf_of : String | Nil = nil, return_url : String | Nil = nil, url : String | 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

configuration
Source
configuration=(new_value : Stripe::BillingPortalSessionConfiguration | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] configuration 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
customer

The ID of the customer for this session.

Source
customer=(new_value : String | Nil)

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

Source
flow
Source
flow=(new_value : Stripe::BillingPortalSessionFlow | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] flow 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
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
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.

Source
locale=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] locale 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
on_behalf_of

The account for which the session was created on behalf of. 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.

Source
on_behalf_of=(new_value : String | Nil)

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

Source
return_url

The URL to redirect customers to when they click on the portal's link to return to your website.

Source
return_url=(new_value : String | Nil)

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

Source
url

The short-lived URL of the session that gives customers access to the customer portal.

Source
url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] url 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