class

Stripe::MandateParams

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

Constants

ERROR_MESSAGE_FOR_INTERVAL = "invalid value for \"interval\", must be one of [one_time, scheduled, variable]."
ERROR_MESSAGE_FOR_NOTIFICATION_METHOD = "invalid value for \"notification_method\", must be one of [deprecated_none, email, manual, none, stripe_email]."
MAX_LENGTH_FOR_INTERVAL = 5000
MAX_LENGTH_FOR_NOTIFICATION_METHOD = 5000
VALID_VALUES_FOR_INTERVAL = String.static_array("one_time", "scheduled", "variable")
VALID_VALUES_FOR_NOTIFICATION_METHOD = String.static_array("deprecated_none", "email", "manual", "none", "stripe_email")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, acceptance : Stripe::MandateAcceptanceParams | Nil = nil, amount : Stripe::MandateParamsAmount | Nil = nil, currency : String | Nil = nil, interval : String | Nil = nil, notification_method : 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

acceptance
Source
acceptance=(new_value : Stripe::MandateAcceptanceParams | Nil)

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

Source
amount
Source
amount=(new_value : Stripe::MandateParamsAmount | Nil)

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

Source
currency

The currency specified by the mandate. (Must match currency of the source)

Source
currency=(new_value : String | Nil)

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

interval

The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)

Source
interval=(new_value : String | Nil)

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

The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).

Source
notification_method=(new_value : String | Nil)

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