Class: Stripe::QuoteCreateParams::SubscriptionData

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

Defined Under Namespace

Classes: BillOnAcceptance, BillingMode, Prebilling

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(bill_on_acceptance: nil, billing_behavior: nil, billing_cycle_anchor: nil, billing_mode: nil, description: nil, effective_date: nil, end_behavior: nil, from_subscription: nil, metadata: nil, prebilling: nil, proration_behavior: nil, trial_period_days: nil) ⇒ SubscriptionData

Returns a new instance of SubscriptionData.



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/stripe/params/quote_create_params.rb', line 844

def initialize(
  bill_on_acceptance: nil,
  billing_behavior: nil,
  billing_cycle_anchor: nil,
  billing_mode: nil,
  description: nil,
  effective_date: nil,
  end_behavior: nil,
  from_subscription: nil,
  metadata: nil,
  prebilling: nil,
  proration_behavior: nil,
  trial_period_days: nil
)
  @bill_on_acceptance = bill_on_acceptance
  @billing_behavior = billing_behavior
  @billing_cycle_anchor = billing_cycle_anchor
  @billing_mode = billing_mode
  @description = description
  @effective_date = effective_date
  @end_behavior = end_behavior
  @from_subscription = from_subscription
  @metadata = metadata
  @prebilling = prebilling
  @proration_behavior = proration_behavior
  @trial_period_days = trial_period_days
end

Instance Attribute Details

#bill_on_acceptance ⇒ Object

Describes the period to bill for upon accepting the quote.



814
815
816
 
# File 'lib/stripe/params/quote_create_params.rb', line 814

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.



816
817
818
 
# File 'lib/stripe/params/quote_create_params.rb', line 816

def billing_behavior
  @billing_behavior
end

#billing_cycle_anchor ⇒ Object

When specified as ‘reset`, the subscription will always start a new billing period when the quote is accepted.



818
819
820
 
# File 'lib/stripe/params/quote_create_params.rb', line 818

def billing_cycle_anchor
  @billing_cycle_anchor
end

#billing_mode ⇒ Object

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



820
821
822
 
# File 'lib/stripe/params/quote_create_params.rb', line 820

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



822
823
824
 
# File 'lib/stripe/params/quote_create_params.rb', line 822

def description
  @description
end

#effective_date ⇒ Object

When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value ‘current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.



824
825
826
 
# File 'lib/stripe/params/quote_create_params.rb', line 824

def effective_date
  @effective_date
end

#end_behavior ⇒ Object

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



826
827
828
 
# File 'lib/stripe/params/quote_create_params.rb', line 826

def end_behavior
  @end_behavior
end

#from_subscription ⇒ Object

The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.



828
829
830
 
# File 'lib/stripe/params/quote_create_params.rb', line 828

def from_subscription
  @from_subscription
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in ‘line_items`, this field will be passed to the resulting subscription’s ‘metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule’s ‘phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.



830
831
832
 
# File 'lib/stripe/params/quote_create_params.rb', line 830

def metadata
  @metadata
end

#prebilling ⇒ Object

If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with ‘effective_date`.



832
833
834
 
# File 'lib/stripe/params/quote_create_params.rb', line 832

def prebilling
  @prebilling
end

#proration_behavior ⇒ Object

Determines how to handle [prorations](docs.stripe.com/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](docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.

Prorations can be disabled by passing ‘none`.



840
841
842
 
# File 'lib/stripe/params/quote_create_params.rb', line 840

def proration_behavior
  @proration_behavior
end

#trial_period_days ⇒ Object

Integer representing the number of trial period days before the customer is charged for the first time.



842
843
844
 
# File 'lib/stripe/params/quote_create_params.rb', line 842

def trial_period_days
  @trial_period_days
end