class

Stripe::CustomerSession

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

A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access control over a Customer. Related guides: Customer Session with the Payment Element, Customer Session with the Pricing Table, Customer Session with the Buy Button.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [customer_session]."
MAX_LENGTH_FOR_CLIENT_SECRET = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("customer_session")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, client_secret : String | Nil = nil, created : Int64 | Nil = nil, customer : Stripe::CustomerSessionCustomer | Nil = nil, expires_at : Int64 | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, components : Stripe::CustomerSessionResourceComponents | 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

client_secret

The client secret of this Customer Session. Used on the client to set up secure access to the given customer. The client secret can be used to provide access to customer from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.

Source
client_secret=(new_value : String | Nil)

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

Source
components
Source
components=(new_value : Stripe::CustomerSessionResourceComponents | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] components 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
Source
customer=(new_value : Stripe::CustomerSessionCustomer | Nil)

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

Source
expires_at

The timestamp at which this Customer Session will expire.

Source
expires_at=(new_value : Int64 | Nil)

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

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
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
valid?

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

Source