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.



2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/stripe/resources/quote.rb', line 2952

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.



2932
2933
2934
 
# File 'lib/stripe/resources/quote.rb', line 2932

def applies_to
  @applies_to
end

#bill_on_acceptance ⇒ Object

Describes the period to bill for upon accepting the quote.



2934
2935
2936
 
# File 'lib/stripe/resources/quote.rb', line 2934

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.



2936
2937
2938
 
# File 'lib/stripe/resources/quote.rb', line 2936

def billing_behavior
  @billing_behavior
end

#customer ⇒ Object

The customer the Subscription Data override applies to.



2938
2939
2940
 
# File 'lib/stripe/resources/quote.rb', line 2938

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.



2940
2941
2942
 
# File 'lib/stripe/resources/quote.rb', line 2940

def description
  @description
end

#end_behavior ⇒ Object

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



2942
2943
2944
 
# File 'lib/stripe/resources/quote.rb', line 2942

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



2950
2951
2952
 
# File 'lib/stripe/resources/quote.rb', line 2950

def proration_behavior
  @proration_behavior
end