Class: Stripe::InvoiceCreatePreviewParams::ScheduleDetails

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/invoice_create_preview_params.rb

Defined Under Namespace

Classes: BillingMode, Phase

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(billing_mode: nil, end_behavior: nil, phases: nil, proration_behavior: nil) ⇒ ScheduleDetails

Returns a new instance of ScheduleDetails.



735
736
737
738
739
740
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 735

def initialize(billing_mode: nil, end_behavior: nil, phases: nil, proration_behavior: nil)
  @billing_mode = billing_mode
  @end_behavior = end_behavior
  @phases = phases
  @proration_behavior = proration_behavior
end

Instance Attribute Details

#billing_mode ⇒ Object

Controls how prorations and invoices for subscriptions are calculated and orchestrated.



727
728
729
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 727

def billing_mode
  @billing_mode
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.



729
730
731
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 729

def end_behavior
  @end_behavior
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.



731
732
733
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 731

def phases
  @phases
end

#proration_behavior ⇒ Object

In cases where the schedule_details params update the currently active phase, specifies if and how to prorate at the time of the request.



733
734
735
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 733

def proration_behavior
  @proration_behavior
end