Class: Stripe::InvoiceCreatePreviewParams::ScheduleDetails

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

Defined Under Namespace

Classes: Amendment, BillingMode, Phase, Prebilling

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

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

Returns a new instance of ScheduleDetails.



1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1436

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

Instance Attribute Details

#amendments ⇒ Object

Changes to apply to the phases of the subscription schedule, in the order provided.



1422
1423
1424
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1422

def amendments
  @amendments
end

#billing_behavior ⇒ Object

Configures when the subscription schedule generates prorations for phase transitions. Possible values are ‘prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.



1424
1425
1426
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1424

def billing_behavior
  @billing_behavior
end

#billing_mode ⇒ Object

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



1426
1427
1428
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1426

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.



1428
1429
1430
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1428

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.



1430
1431
1432
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1430

def phases
  @phases
end

#prebilling ⇒ Object

Provide any time periods to bill in advance.



1432
1433
1434
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1432

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



1434
1435
1436
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1434

def proration_behavior
  @proration_behavior
end