Class: Stripe::V2::Billing::ContractCancelParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/v2/billing/contract_cancel_params.rb

Defined Under Namespace

Classes: CancelPricingLine

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

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

Constructor Details

#initialize(cancel_pricing_lines: nil, include: nil, proration_behavior: nil) ⇒ ContractCancelParams

Returns a new instance of ContractCancelParams.



31
32
33
34
35
 
# File 'lib/stripe/params/v2/billing/contract_cancel_params.rb', line 31

def initialize(cancel_pricing_lines: nil, include: nil, proration_behavior: nil)
  @cancel_pricing_lines = cancel_pricing_lines
  @include = include
  @proration_behavior = proration_behavior
end

Instance Attribute Details

#cancel_pricing_lines ⇒ Object

Per-pricing-line proration behavior overrides. Falls back to proration_behavior if not specified for a given line.



25
26
27
 
# File 'lib/stripe/params/v2/billing/contract_cancel_params.rb', line 25

def cancel_pricing_lines
  @cancel_pricing_lines
end

#include ⇒ Object

Additional fields to include in the response.



27
28
29
 
# File 'lib/stripe/params/v2/billing/contract_cancel_params.rb', line 27

def include
  @include
end

#proration_behavior ⇒ Object

Top-level proration behavior for the cancellation. Defaults to prorated if not set.



29
30
31
 
# File 'lib/stripe/params/v2/billing/contract_cancel_params.rb', line 29

def proration_behavior
  @proration_behavior
end