class

Stripe::SubscriptionSchedule

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

A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. Related guide: Subscription schedules

Constants

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

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, application : Stripe::SubscriptionScheduleApplication | Nil = nil, canceled_at : Int64 | Nil = nil, completed_at : Int64 | Nil = nil, created : Int64 | Nil = nil, current_phase : Stripe::SubscriptionScheduleCurrentPhase1 | 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

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

application
Source
application=(new_value : Stripe::SubscriptionScheduleApplication | Nil)

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

Source
canceled_at

Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

Source
canceled_at=(new_value : Int64 | Nil)

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

Source
completed_at

Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

Source
completed_at=(new_value : Int64 | Nil)

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

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

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

Source
current_phase
Source
current_phase=(new_value : Stripe::SubscriptionScheduleCurrentPhase1 | Nil)

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

Source
customer
Source
customer=(new_value : Stripe::SubscriptionScheduleCustomer | Nil)

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

Source
default_settings
Source
default_settings=(new_value : Stripe::SubscriptionSchedulesResourceDefaultSettings | Nil)

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

Source
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

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

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

Source
list_invalid_properties

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

Source
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

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

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

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

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

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

Source
phases

Configuration for the subscription schedule's phases.

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

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

Source
released_at

Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

Source
released_at=(new_value : Int64 | Nil)

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

Source
released_subscription

ID of the subscription once managed by the subscription schedule (if it is released).

Source
released_subscription=(new_value : String | Nil)

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

Source
status

The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.

Source
status=(new_value : String | Nil)

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

Source
subscription
Source
subscription=(new_value : Stripe::SubscriptionScheduleSubscription | Nil)

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

Source
test_clock
Source
test_clock=(new_value : Stripe::SubscriptionScheduleTestClock | Nil)

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