class

Stripe::Mandate

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

A Mandate is a record of the permission that your customer gives you to debit their payment method.

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [multi_use, single_use]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [mandate]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [active, inactive, pending]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_ON_BEHALF_OF = 5000
VALID_VALUES_FOR__TYPE = String.static_array("multi_use", "single_use")
VALID_VALUES_FOR_OBJECT = String.static_array("mandate")
VALID_VALUES_FOR_STATUS = String.static_array("active", "inactive", "pending")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, customer_acceptance : Stripe::CustomerAcceptance | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, payment_method : Stripe::MandatePaymentMethod | Nil = nil, payment_method_details : Stripe::MandatePaymentMethodDetails | Nil = nil, status : String | Nil = nil, _type : String | Nil = nil, multi_use : JSON::Any | Nil = nil, on_behalf_of : String | Nil = nil, single_use : Stripe::MandateSingleUse | 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

_type

The type of the mandate.

Source
_type=(new_value : String | Nil)

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

Source
customer_acceptance
Source
customer_acceptance=(new_value : Stripe::CustomerAcceptance | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] customer_acceptance 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
multi_use
Source
multi_use=(new_value : JSON::Any | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] multi_use 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 (if any) that the mandate is intended for.

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
payment_method
Source
payment_method=(new_value : Stripe::MandatePaymentMethod | Nil)

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

Source
payment_method_details
Source
payment_method_details=(new_value : Stripe::MandatePaymentMethodDetails | Nil)

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

Source
single_use
Source
single_use=(new_value : Stripe::MandateSingleUse | Nil)

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

Source
status

The mandate status indicates whether or not you can use it to initiate a payment.

Source
status=(new_value : String | Nil)

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