Class: Stripe::Invoice::CreatePreviewParams::ScheduleDetails

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::Invoice::CreatePreviewParams::ScheduleDetails

Defined in:

lib/stripe/resources/invoice.rb

Defined Under Namespace

Classes: BillingMode, Phase

Instance Attribute Summary

• #billing_mode ⇒ Object

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

• #end_behavior ⇒ Object

  Behavior of the subscription schedule and underlying subscription when it ends.

• #phases ⇒ Object

  List representing phases of the subscription schedule.

• #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.

Instance Method Summary

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

  A new instance of ScheduleDetails.

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.

# File 'lib/stripe/resources/invoice.rb', line 2936

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.

# File 'lib/stripe/resources/invoice.rb', line 2928

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.

# File 'lib/stripe/resources/invoice.rb', line 2930

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.

# File 'lib/stripe/resources/invoice.rb', line 2932

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.

# File 'lib/stripe/resources/invoice.rb', line 2934

def proration_behavior
  @proration_behavior
end