Class: Stripe::Quote::UpdateParams::SubscriptionDataOverride

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/quote.rb

Defined Under Namespace

Classes: AppliesTo, BillOnAcceptance

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(applies_to: nil, bill_on_acceptance: nil, billing_behavior: nil, customer: nil, description: nil, end_behavior: nil, proration_behavior: nil) ⇒ SubscriptionDataOverride

Returns a new instance of SubscriptionDataOverride.



2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
 
# File 'lib/stripe/resources/quote.rb', line 2526

def initialize(
  applies_to: nil,
  bill_on_acceptance: nil,
  billing_behavior: nil,
  customer: nil,
  description: nil,
  end_behavior: nil,
  proration_behavior: nil
)
  @applies_to = applies_to
  @bill_on_acceptance = bill_on_acceptance
  @billing_behavior = billing_behavior
  @customer = customer
  @description = description
  @end_behavior = end_behavior
  @proration_behavior = proration_behavior
end

Instance Attribute Details

#applies_to ⇒ Object

Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.



2506
2507
2508
 
# File 'lib/stripe/resources/quote.rb', line 2506

def applies_to
  @applies_to
end

#bill_on_acceptance ⇒ Object

Describes the period to bill for upon accepting the quote.



2508
2509
2510
 
# File 'lib/stripe/resources/quote.rb', line 2508

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



2510
2511
2512
 
# File 'lib/stripe/resources/quote.rb', line 2510

def billing_behavior
  @billing_behavior
end

#customer ⇒ Object

The customer the Subscription Data override applies to.



2512
2513
2514
 
# File 'lib/stripe/resources/quote.rb', line 2512

def customer
  @customer
end

#description ⇒ Object

The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.



2514
2515
2516
 
# File 'lib/stripe/resources/quote.rb', line 2514

def description
  @description
end

#end_behavior ⇒ Object

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



2516
2517
2518
 
# File 'lib/stripe/resources/quote.rb', line 2516

def end_behavior
  @end_behavior
end

#proration_behavior ⇒ Object

Determines how to handle [prorations](stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are ‘create_prorations` or `none`.

When updating a subscription, valid values are ‘create_prorations`, `none`, or `always_invoice`.

Passing ‘create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.

Prorations can be disabled by passing ‘none`.



2524
2525
2526
 
# File 'lib/stripe/resources/quote.rb', line 2524

def proration_behavior
  @proration_behavior
end