Class: Stripe::QuoteUpdateParams::Line::CancelSubscriptionSchedule

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::QuoteUpdateParams::Line::CancelSubscriptionSchedule

Defined in:

lib/stripe/params/quote_update_params.rb

Instance Attribute Summary

• #cancel_at ⇒ Object

  Timestamp helper to cancel the underlying schedule on the accompanying line’s start date.

• #invoice_now ⇒ Object

  If the subscription schedule is ‘active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items.

• #prorate ⇒ Object

  If the subscription schedule is ‘active`, indicates if the cancellation should be prorated.

Instance Method Summary

• #initialize(cancel_at: nil, invoice_now: nil, prorate: nil) ⇒ CancelSubscriptionSchedule constructor

  A new instance of CancelSubscriptionSchedule.

Methods inherited from RequestParams

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

Constructor Details

#initialize(cancel_at: nil, invoice_now: nil, prorate: nil) ⇒ CancelSubscriptionSchedule

Returns a new instance of CancelSubscriptionSchedule.

# File 'lib/stripe/params/quote_update_params.rb', line 417

def initialize(cancel_at: nil, invoice_now: nil, prorate: nil)
  @cancel_at = cancel_at
  @invoice_now = invoice_now
  @prorate = prorate
end

Instance Attribute Details

#cancel_at ⇒ Object

Timestamp helper to cancel the underlying schedule on the accompanying line’s start date. Must be set to ‘line_starts_at`.

# File 'lib/stripe/params/quote_update_params.rb', line 411

def cancel_at
  @cancel_at
end

#invoice_now ⇒ Object

If the subscription schedule is ‘active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.

# File 'lib/stripe/params/quote_update_params.rb', line 413

def invoice_now
  @invoice_now
end

#prorate ⇒ Object

If the subscription schedule is ‘active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.

# File 'lib/stripe/params/quote_update_params.rb', line 415

def prorate
  @prorate
end