class

Stripe::SubscriptionCancelUpdatingParam

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

Constants

ERROR_MESSAGE_FOR_MODE = "invalid value for \"mode\", must be one of [at_period_end, immediately]."
ERROR_MESSAGE_FOR_PRORATION_BEHAVIOR = "invalid value for \"proration_behavior\", must be one of [always_invoice, create_prorations, none]."
VALID_VALUES_FOR_MODE = String.static_array("at_period_end", "immediately")
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(*, cancellation_reason : Stripe::SubscriptionCancellationReasonUpdatingParam | Nil = nil, enabled : Bool | Nil = nil, mode : String | 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

cancellation_reason
Source
cancellation_reason=(new_value : Stripe::SubscriptionCancellationReasonUpdatingParam | Nil)

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

Source
enabled

Whether the feature is enabled.

Source
enabled=(new_value : Bool | Nil)

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

Whether to cancel subscriptions immediately or at the end of the billing period.

Source
mode=(new_value : String | Nil)

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

Source
proration_behavior

Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations, which is only compatible with mode=immediately. No prorations are generated when canceling a subscription at the end of its natural billing period.

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