Class: Stripe::Invoice::UpcomingParams::SubscriptionDetails

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



3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
 
# File 'lib/stripe/resources/invoice.rb', line 3927

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



3892
3893
3894
 
# File 'lib/stripe/resources/invoice.rb', line 3892

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.



3895
3896
3897
 
# File 'lib/stripe/resources/invoice.rb', line 3895

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



3898
3899
3900
 
# File 'lib/stripe/resources/invoice.rb', line 3898

def cancel_at_period_end
  @cancel_at_period_end
end

#cancel_now ⇒ Object

This simulates the subscription being canceled or expired immediately.



3901
3902
3903
 
# File 'lib/stripe/resources/invoice.rb', line 3901

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.



3904
3905
3906
 
# File 'lib/stripe/resources/invoice.rb', line 3904

def default_tax_rates
  @default_tax_rates
end

#items ⇒ Object

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



3907
3908
3909
 
# File 'lib/stripe/resources/invoice.rb', line 3907

def items
  @items
end

#prebilling ⇒ Object

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



3910
3911
3912
 
# File 'lib/stripe/resources/invoice.rb', line 3910

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



3913
3914
3915
 
# File 'lib/stripe/resources/invoice.rb', line 3913

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



3916
3917
3918
 
# File 'lib/stripe/resources/invoice.rb', line 3916

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.



3919
3920
3921
 
# File 'lib/stripe/resources/invoice.rb', line 3919

def resume_at
  @resume_at
end

#start_date ⇒ Object

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



3922
3923
3924
 
# File 'lib/stripe/resources/invoice.rb', line 3922

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.



3925
3926
3927
 
# File 'lib/stripe/resources/invoice.rb', line 3925

def trial_end
  @trial_end
end