class Stripe::BillingPortalSession

Overview

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

Included Modules

Defined in:

stripe/models/billing_portal_session.cr

Constant Summary

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def configuration : Stripe::BillingPortalSessionConfiguration | Nil #

[View source]
def configuration=(new_value : Stripe::BillingPortalSessionConfiguration | Nil) #

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


[View source]
def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

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


[View source]
def customer : String | Nil #

[View source]
def customer=(new_value : String | Nil) #

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


[View source]
def flow : Stripe::BillingPortalSessionFlow | Nil #

[View source]
def flow=(new_value : Stripe::BillingPortalSessionFlow | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def locale : String | Nil #

[View source]
def locale=(new_value : String | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def on_behalf_of : String | Nil #

[View source]
def on_behalf_of=(new_value : String | Nil) #

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


[View source]
def return_url : String | Nil #

[View source]
def return_url=(new_value : String | Nil) #

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


[View source]
def url : String | Nil #

[View source]
def url=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]