class Stripe::SubscriptionSchedule

• Stripe::SubscriptionSchedule
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

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

• .new(pull : JSON::PullParser)
• .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

Instance Method Summary

• #==(other : self)

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

• #application : Stripe::SubscriptionScheduleApplication | Nil
• #application=(new_value : Stripe::SubscriptionScheduleApplication | Nil)

  Custom attribute writer method checking allowed values (enum).

• #canceled_at : Int64 | Nil
• #canceled_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #completed_at : Int64 | Nil
• #completed_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #current_phase : Stripe::SubscriptionScheduleCurrentPhase1 | Nil
• #current_phase=(new_value : Stripe::SubscriptionScheduleCurrentPhase1 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer : Stripe::SubscriptionScheduleCustomer | Nil
• #customer=(new_value : Stripe::SubscriptionScheduleCustomer | Nil)

  Custom attribute writer method checking allowed values (enum).

• #default_settings : Stripe::SubscriptionSchedulesResourceDefaultSettings | Nil
• #default_settings=(new_value : Stripe::SubscriptionSchedulesResourceDefaultSettings | Nil)

  Custom attribute writer method checking allowed values (enum).

• #end_behavior : String | Nil
• #end_behavior=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #phases : Array(Stripe::SubscriptionSchedulePhaseConfiguration) | Nil
• #phases=(new_value : Array(Stripe::SubscriptionSchedulePhaseConfiguration) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #released_at : Int64 | Nil
• #released_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #released_subscription : String | Nil
• #released_subscription=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : String | Nil
• #status=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #subscription : Stripe::SubscriptionScheduleSubscription | Nil
• #subscription=(new_value : Stripe::SubscriptionScheduleSubscription | Nil)

  Custom attribute writer method checking allowed values (enum).

• #test_clock : Stripe::SubscriptionScheduleTestClock | Nil
• #test_clock=(new_value : Stripe::SubscriptionScheduleTestClock | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail