Class: Stripe::BillingPortal::ConfigurationCreateParams::Features::SubscriptionCancel

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



74
75
76
77
78
79
 
# File 'lib/stripe/params/billing_portal/configuration_create_params.rb', line 74

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



66
67
68
 
# File 'lib/stripe/params/billing_portal/configuration_create_params.rb', line 66

def cancellation_reason
  @cancellation_reason
end

#enabled ⇒ Object

Whether the feature is enabled.



68
69
70
 
# File 'lib/stripe/params/billing_portal/configuration_create_params.rb', line 68

def enabled
  @enabled
end

#mode ⇒ Object

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



70
71
72
 
# File 'lib/stripe/params/billing_portal/configuration_create_params.rb', line 70

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.



72
73
74
 
# File 'lib/stripe/params/billing_portal/configuration_create_params.rb', line 72

def proration_behavior
  @proration_behavior
end