Class: Stripe::SubscriptionSchedule::AmendParams::Amendment

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/subscription_schedule.rb

Defined Under Namespace

Classes: AmendmentEnd, AmendmentStart, DiscountAction, ItemAction, MetadataAction, SetPauseCollection, TrialSettings

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amendment_end: nil, amendment_start: nil, billing_cycle_anchor: nil, discount_actions: nil, item_actions: nil, metadata_actions: nil, proration_behavior: nil, set_pause_collection: nil, set_schedule_end: nil, trial_settings: nil) ⇒ Amendment

Returns a new instance of Amendment.



2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2202

def initialize(
  amendment_end: nil,
  amendment_start: nil,
  billing_cycle_anchor: nil,
  discount_actions: nil,
  item_actions: nil,
  metadata_actions: nil,
  proration_behavior: nil,
  set_pause_collection: nil,
  set_schedule_end: nil,
  trial_settings: nil
)
  @amendment_end = amendment_end
  @amendment_start = amendment_start
  @billing_cycle_anchor = billing_cycle_anchor
  @discount_actions = discount_actions
  @item_actions = item_actions
  @metadata_actions = metadata_actions
  @proration_behavior = proration_behavior
  @set_pause_collection = set_pause_collection
  @set_schedule_end = set_schedule_end
  @trial_settings = trial_settings
end

Instance Attribute Details

#amendment_end ⇒ Object

Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at ‘amendment_start`, and a restricted set of attributes is supported on the amendment.



2182
2183
2184
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2182

def amendment_end
  @amendment_end
end

#amendment_start ⇒ Object

Details to identify the earliest timestamp where the proposed change should take effect.



2184
2185
2186
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2184

def amendment_start
  @amendment_start
end

#billing_cycle_anchor ⇒ Object

For point-in-time amendments (having no ‘amendment_end`), this attribute lets you set or remove whether the subscription’s billing cycle anchor is reset at the ‘amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.



2186
2187
2188
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2186

def billing_cycle_anchor
  @billing_cycle_anchor
end

#discount_actions ⇒ Object

Changes to the coupons being redeemed or discounts being applied during the amendment time span.



2188
2189
2190
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2188

def discount_actions
  @discount_actions
end

#item_actions ⇒ Object

Changes to the subscription items during the amendment time span.



2190
2191
2192
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2190

def item_actions
  @item_actions
end

#metadata_actions ⇒ Object

Instructions for how to modify phase metadata



2192
2193
2194
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2192

def metadata_actions
  @metadata_actions
end

#proration_behavior ⇒ Object

Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when ‘amendment_end` is `null`.



2194
2195
2196
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2194

def proration_behavior
  @proration_behavior
end

#set_pause_collection ⇒ Object

Defines how to pause collection for the underlying subscription throughout the duration of the amendment.



2196
2197
2198
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2196

def set_pause_collection
  @set_pause_collection
end

#set_schedule_end ⇒ Object

Ends the subscription schedule early as dictated by either the accompanying amendment’s start or end.



2198
2199
2200
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2198

def set_schedule_end
  @set_schedule_end
end

#trial_settings ⇒ Object

Settings related to subscription trials.



2200
2201
2202
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2200

def trial_settings
  @trial_settings
end