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

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

Defined Under Namespace

Classes: CancellationReason

Constant Summary

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Method Summary

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#cancellation_reason ⇒ Object (readonly)

Attribute for field cancellation_reason



52
53
54
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 52

def cancellation_reason
  @cancellation_reason
end

#enabled ⇒ Object (readonly)

Whether the feature is enabled.



54
55
56
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 54

def enabled
  @enabled
end

#mode ⇒ Object (readonly)

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



56
57
58
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 56

def mode
  @mode
end

#proration_behavior ⇒ Object (readonly)

Whether to create prorations when canceling subscriptions. Possible values are ‘none` and `create_prorations`.



58
59
60
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 58

def proration_behavior
  @proration_behavior
end