class Stripe::PortalSubscriptionCancel

Overview

Included Modules

Defined in:

stripe/models/portal_subscription_cancel.cr

Constant Summary

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, cancellation_reason : Stripe::PortalSubscriptionCancellationReason | 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


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def cancellation_reason : Stripe::PortalSubscriptionCancellationReason | Nil #

[View source]
def cancellation_reason=(new_value : Stripe::PortalSubscriptionCancellationReason | Nil) #

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


[View source]
def enabled : Bool | Nil #

[View source]
def enabled=(new_value : Bool | Nil) #

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


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def list_invalid_properties : Array(String) #

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


[View source]
def mode : String | Nil #

[View source]
def mode=(new_value : String | Nil) #

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


[View source]
def proration_behavior : String | Nil #

[View source]
def proration_behavior=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]