class

Stripe::MandateOptionsParam

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_COLLECTION_METHOD = "invalid value for \"collection_method\", must be one of [, paper]."
ERROR_MESSAGE_FOR_DEFAULT_FOR = "invalid value for \"default_for\", must be one of [invoice, subscription]."
ERROR_MESSAGE_FOR_INTERVAL = "invalid value for \"interval\", must be one of [day, month, sporadic, week, year]."
ERROR_MESSAGE_FOR_PAYMENT_SCHEDULE = "invalid value for \"payment_schedule\", must be one of [combined, interval, sporadic]."
ERROR_MESSAGE_FOR_SUPPORTED_TYPES = "invalid value for \"supported_types\", must be one of [india]."
ERROR_MESSAGE_FOR_TRANSACTION_TYPE = "invalid value for \"transaction_type\", must be one of [business, personal]."
MAX_LENGTH_FOR_DESCRIPTION = 200
MAX_LENGTH_FOR_INTERVAL_DESCRIPTION = 500
MAX_LENGTH_FOR_REFERENCE = 80
VALID_VALUES_FOR_AMOUNT_TYPE = String.static_array("fixed", "maximum")
VALID_VALUES_FOR_COLLECTION_METHOD = String.static_array("", "paper")
VALID_VALUES_FOR_DEFAULT_FOR = String.static_array("invoice", "subscription")
VALID_VALUES_FOR_INTERVAL = String.static_array("day", "month", "sporadic", "week", "year")
VALID_VALUES_FOR_PAYMENT_SCHEDULE = String.static_array("combined", "interval", "sporadic")
VALID_VALUES_FOR_SUPPORTED_TYPES = String.static_array("india")
VALID_VALUES_FOR_TRANSACTION_TYPE = String.static_array("business", "personal")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, amount_type : String | Nil = nil, interval : String | Nil = nil, reference : String | Nil = nil, start_date : Int64 | Nil = nil, collection_method : String | Nil = nil, custom_mandate_url : Stripe::MandateOptionsParamCustomMandateUrl | Nil = nil, default_for : Array(String) | Nil = nil, description : String | Nil = nil, end_date : Int64 | Nil = nil, interval_count : Int64 | Nil = nil, interval_description : String | Nil = nil, payment_schedule : String | Nil = nil, supported_types : Array(String) | Nil = nil, transaction_type : 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
collection_method

The method used to collect offline mandate customer acceptance.

Source
collection_method=(new_value : String | Nil)

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

Source
custom_mandate_url
Source
custom_mandate_url=(new_value : Stripe::MandateOptionsParamCustomMandateUrl | Nil)

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

Source
default_for

List of Stripe products where this mandate can be selected automatically. Only usable in setup mode.

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

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

Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.

Source
interval_description=(new_value : String | Nil)

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

Payment schedule for the mandate.

Source
payment_schedule=(new_value : String | Nil)

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

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
transaction_type

Transaction type of the mandate.

Source
transaction_type=(new_value : String | Nil)

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