Class: Stripe::InvoiceService::UpcomingParams::SubscriptionDetails

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

Defined Under Namespace

Classes: Item, Prebilling

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(billing_cycle_anchor: nil, cancel_at: nil, cancel_at_period_end: nil, cancel_now: nil, default_tax_rates: nil, items: nil, prebilling: nil, proration_behavior: nil, proration_date: nil, resume_at: nil, start_date: nil, trial_end: nil) ⇒ SubscriptionDetails

Returns a new instance of SubscriptionDetails.



2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
 
# File 'lib/stripe/services/invoice_service.rb', line 2952

def initialize(
  billing_cycle_anchor: nil,
  cancel_at: nil,
  cancel_at_period_end: nil,
  cancel_now: nil,
  default_tax_rates: nil,
  items: nil,
  prebilling: nil,
  proration_behavior: nil,
  proration_date: nil,
  resume_at: nil,
  start_date: nil,
  trial_end: nil
)
  @billing_cycle_anchor = billing_cycle_anchor
  @cancel_at = cancel_at
  @cancel_at_period_end = cancel_at_period_end
  @cancel_now = cancel_now
  @default_tax_rates = default_tax_rates
  @items = items
  @prebilling = prebilling
  @proration_behavior = proration_behavior
  @proration_date = proration_date
  @resume_at = resume_at
  @start_date = start_date
  @trial_end = trial_end
end

Instance Attribute Details

#billing_cycle_anchor ⇒ Object

For new subscriptions, a future timestamp to anchor the subscription’s [billing cycle](stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with ‘month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.



2928
2929
2930
 
# File 'lib/stripe/services/invoice_service.rb', line 2928

def billing_cycle_anchor
  @billing_cycle_anchor
end

#cancel_at ⇒ Object

A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using ‘proration_behavior`. If set during a future period, this will always cause a proration for that period.



2930
2931
2932
 
# File 'lib/stripe/services/invoice_service.rb', line 2930

def cancel_at
  @cancel_at
end

#cancel_at_period_end ⇒ Object

Indicate whether this subscription should cancel at the end of the current period (‘current_period_end`). Defaults to `false`.



2932
2933
2934
 
# File 'lib/stripe/services/invoice_service.rb', line 2932

def cancel_at_period_end
  @cancel_at_period_end
end

#cancel_now ⇒ Object

This simulates the subscription being canceled or expired immediately.



2934
2935
2936
 
# File 'lib/stripe/services/invoice_service.rb', line 2934

def cancel_now
  @cancel_now
end

#default_tax_rates ⇒ Object

If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have ‘tax_rates` set.



2936
2937
2938
 
# File 'lib/stripe/services/invoice_service.rb', line 2936

def default_tax_rates
  @default_tax_rates
end

#items ⇒ Object

A list of up to 20 subscription items, each with an attached price.



2938
2939
2940
 
# File 'lib/stripe/services/invoice_service.rb', line 2938

def items
  @items
end

#prebilling ⇒ Object

The pre-billing to apply to the subscription as a preview.



2940
2941
2942
 
# File 'lib/stripe/services/invoice_service.rb', line 2940

def prebilling
  @prebilling
end

#proration_behavior ⇒ Object

Determines how to handle [prorations](stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting ‘billing_cycle_anchor=now`, or starting a trial), or if an item’s ‘quantity` changes. The default value is `create_prorations`.



2942
2943
2944
 
# File 'lib/stripe/services/invoice_service.rb', line 2942

def proration_behavior
  @proration_behavior
end

#proration_date ⇒ Object

If previewing an update to a subscription, and doing proration, ‘subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to ’none’.



2944
2945
2946
 
# File 'lib/stripe/services/invoice_service.rb', line 2944

def proration_date
  @proration_date
end

#resume_at ⇒ Object

For paused subscriptions, setting ‘subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.



2946
2947
2948
 
# File 'lib/stripe/services/invoice_service.rb', line 2946

def resume_at
  @resume_at
end

#start_date ⇒ Object

Date a subscription is intended to start (can be future or past).



2948
2949
2950
 
# File 'lib/stripe/services/invoice_service.rb', line 2948

def start_date
  @start_date
end

#trial_end ⇒ Object

If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of ‘subscription_details.items` or `subscription` is required.



2950
2951
2952
 
# File 'lib/stripe/services/invoice_service.rb', line 2950

def trial_end
  @trial_end
end