class

Stripe::PortalSubscriptionUpdate

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

Constants

ERROR_MESSAGE_FOR_DEFAULT_ALLOWED_UPDATES = "invalid value for \"default_allowed_updates\", must be one of [price, promotion_code, quantity]."
ERROR_MESSAGE_FOR_PRORATION_BEHAVIOR = "invalid value for \"proration_behavior\", must be one of [always_invoice, create_prorations, none]."
VALID_VALUES_FOR_DEFAULT_ALLOWED_UPDATES = String.static_array("price", "promotion_code", "quantity")
VALID_VALUES_FOR_PRORATION_BEHAVIOR = String.static_array("always_invoice", "create_prorations", "none")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, default_allowed_updates : Array(String) | Nil = nil, enabled : Bool | Nil = nil, proration_behavior : String | Nil = nil, products : Array(Stripe::PortalSubscriptionUpdateProduct) | 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

default_allowed_updates

The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.

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

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

The list of up to 10 products that support subscription updates.

Source
products=(new_value : Array(Stripe::PortalSubscriptionUpdateProduct) | Nil)

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

Source
products_present=(products_present : Bool)
Source
products_present?
Source
proration_behavior

Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don't set it during creation.

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