class

Stripe::SetupIntentMandateOptionsParam

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

Constants

ERROR_MESSAGE_FOR_AMOUNT_TYPE = "invalid value for \"amount_type\", must be one of [fixed, maximum]."
ERROR_MESSAGE_FOR_INTERVAL = "invalid value for \"interval\", must be one of [day, month, sporadic, week, year]."
ERROR_MESSAGE_FOR_SUPPORTED_TYPES = "invalid value for \"supported_types\", must be one of [india]."
MAX_LENGTH_FOR_DESCRIPTION = 200
MAX_LENGTH_FOR_REFERENCE = 80
VALID_VALUES_FOR_AMOUNT_TYPE = String.static_array("fixed", "maximum")
VALID_VALUES_FOR_INTERVAL = String.static_array("day", "month", "sporadic", "week", "year")
VALID_VALUES_FOR_SUPPORTED_TYPES = String.static_array("india")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, amount_type : String | Nil = nil, currency : String | Nil = nil, interval : String | Nil = nil, reference : String | Nil = nil, start_date : Int64 | Nil = nil, description : String | Nil = nil, end_date : Int64 | Nil = nil, interval_count : Int64 | Nil = nil, supported_types : Array(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

amount

Amount to be charged for future payments.

Source
amount=(new_value : Int64 | Nil)

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

Source
amount_type

One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.

Source
amount_type=(new_value : String | Nil)

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

Source
currency

Currency in which future payments will be charged. Three-letter ISO currency code, in lowercase. Must be a supported currency.

Source
currency=(new_value : String | Nil)

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

Source
description

A description of the mandate or subscription that is meant to be displayed to the customer.

Source
description=(new_value : String | Nil)

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

Source
end_date

End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.

Source
end_date=(new_value : Int64 | Nil)

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

Specifies payment frequency. One of day, week, month, year, or sporadic.

Source
interval=(new_value : String | Nil)

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

Source
interval_count

The number of intervals between payments. For example, interval=month and interval_count=3 indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when interval=sporadic.

Source
interval_count=(new_value : Int64 | Nil)

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

Unique identifier for the mandate or subscription.

Source
reference=(new_value : String | Nil)

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

Source
start_date

Start date of the mandate or subscription. Start date should not be lesser than yesterday.

Source
start_date=(new_value : Int64 | Nil)

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

Source
supported_types

Specifies the type of mandates supported. Possible values are india.

Source
supported_types=(new_value : Array(String) | Nil)

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