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

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/invoice.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.



3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/stripe/resources/invoice.rb', line 3398

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.



3378
3379
3380
 
# File 'lib/stripe/resources/invoice.rb', line 3378

def amendment_end
  @amendment_end
end

#amendment_start ⇒ Object

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



3380
3381
3382
 
# File 'lib/stripe/resources/invoice.rb', line 3380

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.



3382
3383
3384
 
# File 'lib/stripe/resources/invoice.rb', line 3382

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.



3384
3385
3386
 
# File 'lib/stripe/resources/invoice.rb', line 3384

def discount_actions
  @discount_actions
end

#item_actions ⇒ Object

Changes to the subscription items during the amendment time span.



3386
3387
3388
 
# File 'lib/stripe/resources/invoice.rb', line 3386

def item_actions
  @item_actions
end

#metadata_actions ⇒ Object

Instructions for how to modify phase metadata



3388
3389
3390
 
# File 'lib/stripe/resources/invoice.rb', line 3388

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`.



3390
3391
3392
 
# File 'lib/stripe/resources/invoice.rb', line 3390

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.



3392
3393
3394
 
# File 'lib/stripe/resources/invoice.rb', line 3392

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.



3394
3395
3396
 
# File 'lib/stripe/resources/invoice.rb', line 3394

def set_schedule_end
  @set_schedule_end
end

#trial_settings ⇒ Object

Settings related to subscription trials.



3396
3397
3398
 
# File 'lib/stripe/resources/invoice.rb', line 3396

def trial_settings
  @trial_settings
end