Class: Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel

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

Defined Under Namespace

Classes: CancellationReason

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(cancellation_reason: nil, enabled: nil, mode: nil, proration_behavior: nil) ⇒ SubscriptionCancel

Returns a new instance of SubscriptionCancel.



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 208

def initialize(
  cancellation_reason: nil,
  enabled: nil,
  mode: nil,
  proration_behavior: nil
)
  @cancellation_reason = cancellation_reason
  @enabled = enabled
  @mode = mode
  @proration_behavior = proration_behavior
end

Instance Attribute Details

#cancellation_reason ⇒ Object

Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer



200
201
202
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 200

def cancellation_reason
  @cancellation_reason
end

#enabled ⇒ Object

Whether the feature is enabled.



202
203
204
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 202

def enabled
  @enabled
end

#mode ⇒ Object

Whether to cancel subscriptions immediately or at the end of the billing period.



204
205
206
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 204

def mode
  @mode
end

#proration_behavior ⇒ Object

Whether to create prorations when canceling subscriptions. Possible values are ‘none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.



206
207
208
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 206

def proration_behavior
  @proration_behavior
end