Class: Stripe::SubscriptionSchedule::CancelParams

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::SubscriptionSchedule::CancelParams

Defined in:

lib/stripe/resources/subscription_schedule.rb

Instance Attribute Summary

• #expand ⇒ Object

  Specifies which fields in the response should be expanded.

• #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(expand: nil, invoice_now: nil, prorate: nil) ⇒ CancelParams constructor

  A new instance of CancelParams.

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(expand: nil, invoice_now: nil, prorate: nil) ⇒ CancelParams

Returns a new instance of CancelParams.

# File 'lib/stripe/resources/subscription_schedule.rb', line 2801

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

Instance Attribute Details

#expand ⇒ Object

Specifies which fields in the response should be expanded.

# File 'lib/stripe/resources/subscription_schedule.rb', line 2795

def expand
  @expand
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. Defaults to `true`.

# File 'lib/stripe/resources/subscription_schedule.rb', line 2797

def invoice_now
  @invoice_now
end

#prorate ⇒ Object

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

# File 'lib/stripe/resources/subscription_schedule.rb', line 2799

def prorate
  @prorate
end