Class: Stripe::SubscriptionScheduleUpdateParams::PauseSchedule::Pause::Settings

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::SubscriptionScheduleUpdateParams::PauseSchedule::Pause::Settings

Defined in:

lib/stripe/params/subscription_schedule_update_params.rb

Defined Under Namespace

Classes: BillFor

Instance Attribute Summary

• #bill_for ⇒ Object

  Controls what to bill for when pausing the subscription.

• #invoicing_behavior ⇒ Object

  Determines whether to generate an invoice for outstanding amounts when pausing.

• #type ⇒ Object

  The pause type.

Instance Method Summary

• #initialize(bill_for: nil, invoicing_behavior: nil, type: nil) ⇒ Settings constructor

  A new instance of Settings.

Methods inherited from RequestParams

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

Constructor Details

#initialize(bill_for: nil, invoicing_behavior: nil, type: nil) ⇒ Settings

Returns a new instance of Settings.

# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 203

def initialize(bill_for: nil, invoicing_behavior: nil, type: nil)
  @bill_for = bill_for
  @invoicing_behavior = invoicing_behavior
  @type = type
end

Instance Attribute Details

#bill_for ⇒ Object

Controls what to bill for when pausing the subscription.

# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 197

def bill_for
  @bill_for
end

#invoicing_behavior ⇒ Object

Determines whether to generate an invoice for outstanding amounts when pausing. When adding a pause schedule, defaults to pending_invoice_item. On updates, the existing value is preserved if not provided.

# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 199

def invoicing_behavior
  @invoicing_behavior
end

#type ⇒ Object

The pause type. Currently only subscription is supported.

# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 201

def type
  @type
end