Class: Stripe::QuoteService::CreateParams::SubscriptionData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/quote_service.rb

Defined Under Namespace

Classes: BillOnAcceptance, BillingMode, Prebilling

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

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



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/stripe/services/quote_service.rb', line 871

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.



841
842
843
 
# File 'lib/stripe/services/quote_service.rb', line 841

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.



843
844
845
 
# File 'lib/stripe/services/quote_service.rb', line 843

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.



845
846
847
 
# File 'lib/stripe/services/quote_service.rb', line 845

def billing_cycle_anchor
  @billing_cycle_anchor
end

#billing_mode ⇒ Object

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



847
848
849
 
# File 'lib/stripe/services/quote_service.rb', line 847

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.



849
850
851
 
# File 'lib/stripe/services/quote_service.rb', line 849

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.



851
852
853
 
# File 'lib/stripe/services/quote_service.rb', line 851

def effective_date
  @effective_date
end

#end_behavior ⇒ Object

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



853
854
855
 
# File 'lib/stripe/services/quote_service.rb', line 853

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.



855
856
857
 
# File 'lib/stripe/services/quote_service.rb', line 855

def from_subscription
  @from_subscription
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/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.



857
858
859
 
# File 'lib/stripe/services/quote_service.rb', line 857

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



859
860
861
 
# File 'lib/stripe/services/quote_service.rb', line 859

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



867
868
869
 
# File 'lib/stripe/services/quote_service.rb', line 867

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.



869
870
871
 
# File 'lib/stripe/services/quote_service.rb', line 869

def trial_period_days
  @trial_period_days
end