Class: Stripe::QuoteService::UpdateParams::SubscriptionDataOverride

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/quote_service.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.



2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
 
# File 'lib/stripe/services/quote_service.rb', line 2360

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.



2334
2335
2336
 
# File 'lib/stripe/services/quote_service.rb', line 2334

def applies_to
  @applies_to
end

#bill_on_acceptance ⇒ Object

Describes the period to bill for upon accepting the quote.



2337
2338
2339
 
# File 'lib/stripe/services/quote_service.rb', line 2337

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.



2340
2341
2342
 
# File 'lib/stripe/services/quote_service.rb', line 2340

def billing_behavior
  @billing_behavior
end

#customer ⇒ Object

The customer the Subscription Data override applies to.



2343
2344
2345
 
# File 'lib/stripe/services/quote_service.rb', line 2343

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.



2346
2347
2348
 
# File 'lib/stripe/services/quote_service.rb', line 2346

def description
  @description
end

#end_behavior ⇒ Object

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



2349
2350
2351
 
# File 'lib/stripe/services/quote_service.rb', line 2349

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`.



2358
2359
2360
 
# File 'lib/stripe/services/quote_service.rb', line 2358

def proration_behavior
  @proration_behavior
end