Class: Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction

Defined in:

lib/stripe/resources/invoice.rb

Defined Under Namespace

Classes: Add, Remove, Set

Instance Attribute Summary

• #add ⇒ Object

  Details of the subscription item to add.

• #remove ⇒ Object

  Details of the subscription item to remove.

• #set ⇒ Object

  Details of the subscription item to replace the existing items with.

• #type ⇒ Object

  Determines the type of item action.

Instance Method Summary

• #initialize(add: nil, remove: nil, set: nil, type: nil) ⇒ ItemAction constructor

  A new instance of ItemAction.

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(add: nil, remove: nil, set: nil, type: nil) ⇒ ItemAction

Returns a new instance of ItemAction.

# File 'lib/stripe/resources/invoice.rb', line 3315

def initialize(add: nil, remove: nil, set: nil, type: nil)
  @add = add
  @remove = remove
  @set = set
  @type = type
end

Instance Attribute Details

#add ⇒ Object

Details of the subscription item to add. If an item with the same ‘price` exists, it will be replaced by this new item. Otherwise, it adds the new item.

# File 'lib/stripe/resources/invoice.rb', line 3307

def add
  @add
end

#remove ⇒ Object

Details of the subscription item to remove.

# File 'lib/stripe/resources/invoice.rb', line 3309

def remove
  @remove
end

#set ⇒ Object

Details of the subscription item to replace the existing items with. If an item with the ‘set` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.

# File 'lib/stripe/resources/invoice.rb', line 3311

def set
  @set
end

#type ⇒ Object

Determines the type of item action.

# File 'lib/stripe/resources/invoice.rb', line 3313

def type
  @type
end