Class: Stripe::BillingPortal::ConfigurationUpdateParams::Features::SubscriptionUpdate

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/billing_portal/configuration_update_params.rb

Defined Under Namespace

Classes: Product, ScheduleAtPeriodEnd

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(default_allowed_updates: nil, enabled: nil, products: nil, proration_behavior: nil, schedule_at_period_end: nil, trial_update_behavior: nil) ⇒ SubscriptionUpdate 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 141

def initialize(
  default_allowed_updates: nil,
  enabled: nil,
  products: nil,
  proration_behavior: nil,
  schedule_at_period_end: nil,
  trial_update_behavior: nil
)
  @default_allowed_updates = default_allowed_updates
  @enabled = enabled
  @products = products
  @proration_behavior = proration_behavior
  @schedule_at_period_end = schedule_at_period_end
  @trial_update_behavior = trial_update_behavior
end

Instance Attribute Details

#default_allowed_updates ⇒ Object

The types of subscription updates that are supported. When empty, subscriptions are not updateable.



129
130
131
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 129

def default_allowed_updates
  @default_allowed_updates
end

#enabled ⇒ Object

Whether the feature is enabled.



131
132
133
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 131

def enabled
  @enabled
end

#products ⇒ Object

The list of up to 10 products that support subscription updates.



133
134
135
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 133

def products
  @products
end

#proration_behavior ⇒ Object

Determines how to handle prorations resulting from subscription updates. Valid values are ‘none`, `create_prorations`, and `always_invoice`.



135
136
137
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 135

def proration_behavior
  @proration_behavior
end

#schedule_at_period_end ⇒ Object

Setting to control when an update should be scheduled at the end of the period instead of applying immediately.



137
138
139
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 137

def schedule_at_period_end
  @schedule_at_period_end
end

#trial_update_behavior ⇒ Object

The behavior when updating a subscription that is trialing.



139
140
141
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 139

def trial_update_behavior
  @trial_update_behavior
end