class

Stripe::ScheduleDetailsParams

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

Constants

ERROR_MESSAGE_FOR_END_BEHAVIOR = "invalid value for \"end_behavior\", must be one of [cancel, release]."
ERROR_MESSAGE_FOR_PRORATION_BEHAVIOR = "invalid value for \"proration_behavior\", must be one of [always_invoice, create_prorations, none]."
VALID_VALUES_FOR_END_BEHAVIOR = String.static_array("cancel", "release")
VALID_VALUES_FOR_PRORATION_BEHAVIOR = String.static_array("always_invoice", "create_prorations", "none")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, end_behavior : String | Nil = nil, phases : Array(Stripe::PhaseConfigurationParams) | Nil = nil, proration_behavior : 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

end_behavior

Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.

Source
end_behavior=(new_value : String | Nil)

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

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
phases

List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase.

Source
phases=(new_value : Array(Stripe::PhaseConfigurationParams) | Nil)

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

Source
proration_behavior

In cases where the schedule_details params update the currently active phase, specifies if and how to prorate at the time of the request.

Source
proration_behavior=(new_value : String | Nil)

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