class Stripe::Mandate

• Stripe::Mandate
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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)
• .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

Instance Method Summary

• #==(other : self)

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

• #_type : String | Nil
• #_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer_acceptance : Stripe::CustomerAcceptance | Nil
• #customer_acceptance=(new_value : Stripe::CustomerAcceptance | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #multi_use : JSON::Any | Nil
• #multi_use=(new_value : JSON::Any | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #on_behalf_of : String | Nil
• #on_behalf_of=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method : Stripe::MandatePaymentMethod | Nil
• #payment_method=(new_value : Stripe::MandatePaymentMethod | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_details : Stripe::MandatePaymentMethodDetails | Nil
• #payment_method_details=(new_value : Stripe::MandatePaymentMethodDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

• #single_use : Stripe::MandateSingleUse | Nil
• #single_use=(new_value : Stripe::MandateSingleUse | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : String | Nil
• #status=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail