Class: Stripe::SubscriptionScheduleUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/subscription_schedule_update_params.rb

Defined Under Namespace

Classes: DefaultSettings, Phase

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(default_settings: nil, end_behavior: nil, expand: nil, metadata: nil, phases: nil, proration_behavior: nil) ⇒ SubscriptionScheduleUpdateParams

Returns a new instance of SubscriptionScheduleUpdateParams.



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 546

def initialize(
  default_settings: nil,
  end_behavior: nil,
  expand: nil,
  metadata: nil,
  phases: nil,
  proration_behavior: nil
)
  @default_settings = default_settings
  @end_behavior = end_behavior
  @expand = expand
  @metadata = metadata
  @phases = phases
  @proration_behavior = proration_behavior
end

Instance Attribute Details

#default_settings ⇒ Object

Object representing the subscription schedule’s default settings.



534
535
536
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 534

def default_settings
  @default_settings
end

#end_behavior ⇒ Object

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.



536
537
538
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 536

def end_behavior
  @end_behavior
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



538
539
540
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 538

def expand
  @expand
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.



540
541
542
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 540

def metadata
  @metadata
end

#phases ⇒ Object

List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase. Note that past phases can be omitted.



542
543
544
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 542

def phases
  @phases
end

#proration_behavior ⇒ Object

If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is create_prorations.



544
545
546
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 544

def proration_behavior
  @proration_behavior
end