class Stripe::QuoteSubscriptionSchedule

Overview

The subscription schedule that was created or updated from this quote.

Included Modules

Defined in:

stripe/models/quote_subscription_schedule.cr

Constant Summary

ERROR_MESSAGE_FOR_END_BEHAVIOR = "invalid value for \"end_behavior\", must be one of [cancel, none, release, renew]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [subscription_schedule]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [active, canceled, completed, not_started, released]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_RELEASED_SUBSCRIPTION = 5000
VALID_VALUES_FOR_END_BEHAVIOR = String.static_array("cancel", "none", "release", "renew")
VALID_VALUES_FOR_OBJECT = String.static_array("subscription_schedule")
VALID_VALUES_FOR_STATUS = String.static_array("active", "canceled", "completed", "not_started", "released")

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, 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(*, application : Stripe::SubscriptionScheduleApplication | Nil = nil, canceled_at : Int64 | Nil = nil, completed_at : Int64 | Nil = nil, created : Int64 | Nil = nil, current_phase : Stripe::SubscriptionScheduleCurrentPhase | Nil = nil, customer : Stripe::SubscriptionScheduleCustomer | Nil = nil, default_settings : Stripe::SubscriptionSchedulesResourceDefaultSettings | Nil = nil, end_behavior : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, phases : Array(Stripe::SubscriptionSchedulePhaseConfiguration) | Nil = nil, released_at : Int64 | Nil = nil, released_subscription : String | Nil = nil, status : String | Nil = nil, subscription : Stripe::SubscriptionScheduleSubscription | Nil = nil, test_clock : Stripe::SubscriptionScheduleTestClock | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]

Class Method Detail

def self.openapi_any_of #

End of Required Properties List of class defined in anyOf (OpenAPI v3)


[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 application : Stripe::SubscriptionScheduleApplication | Nil #

[View source]
def application=(application : Stripe::SubscriptionScheduleApplication | Nil) #

[View source]
def canceled_at : Int64 | Nil #

[View source]
def canceled_at=(canceled_at : Int64 | Nil) #

[View source]
def completed_at : Int64 | Nil #

[View source]
def completed_at=(completed_at : Int64 | Nil) #

[View source]
def created : Int64 | Nil #

[View source]
def created=(created : Int64 | Nil) #

[View source]
def current_phase : Stripe::SubscriptionScheduleCurrentPhase | Nil #

[View source]
def current_phase=(current_phase : Stripe::SubscriptionScheduleCurrentPhase | Nil) #

[View source]
def customer : Stripe::SubscriptionScheduleCustomer | Nil #

[View source]
def customer=(customer : Stripe::SubscriptionScheduleCustomer | Nil) #

[View source]
def default_settings : Stripe::SubscriptionSchedulesResourceDefaultSettings | Nil #

[View source]
def default_settings=(default_settings : Stripe::SubscriptionSchedulesResourceDefaultSettings | Nil) #

[View source]
def end_behavior : String | Nil #

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

[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 id : String | Nil #

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

[View source]
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 livemode : Bool | Nil #

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

[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(metadata : Hash(String, String) | Nil) #

[View source]
def object : String | Nil #

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

[View source]
def phases : Array(Stripe::SubscriptionSchedulePhaseConfiguration) | Nil #

[View source]
def phases=(phases : Array(Stripe::SubscriptionSchedulePhaseConfiguration) | Nil) #

[View source]
def released_at : Int64 | Nil #

[View source]
def released_at=(released_at : Int64 | Nil) #

[View source]
def released_subscription : String | Nil #

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

[View source]
def status : String | Nil #

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

[View source]
def subscription : Stripe::SubscriptionScheduleSubscription | Nil #

[View source]
def subscription=(subscription : Stripe::SubscriptionScheduleSubscription | Nil) #

[View source]
def test_clock : Stripe::SubscriptionScheduleTestClock | Nil #

[View source]
def test_clock=(test_clock : Stripe::SubscriptionScheduleTestClock | Nil) #

[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]