Class: Stripe::BillingPortal::Session::CreateParams::FlowData

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

Defined Under Namespace

Classes: AfterCompletion, SubscriptionCancel, SubscriptionUpdate, SubscriptionUpdateConfirm

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(after_completion: nil, subscription_cancel: nil, subscription_update: nil, subscription_update_confirm: nil, type: nil) ⇒ FlowData

Returns a new instance of FlowData.



255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/stripe/resources/billing_portal/session.rb', line 255

def initialize(
  after_completion: nil,
  subscription_cancel: nil,
  subscription_update: nil,
  subscription_update_confirm: nil,
  type: nil
)
  @after_completion = after_completion
  @subscription_cancel = subscription_cancel
  @subscription_update = subscription_update
  @subscription_update_confirm = subscription_update_confirm
  @type = type
end

Instance Attribute Details

#after_completionObject

Behavior after the flow is completed.



241
242
243
# File 'lib/stripe/resources/billing_portal/session.rb', line 241

def after_completion
  @after_completion
end

#subscription_cancelObject

Configuration when ‘flow_data.type=subscription_cancel`.



244
245
246
# File 'lib/stripe/resources/billing_portal/session.rb', line 244

def subscription_cancel
  @subscription_cancel
end

#subscription_updateObject

Configuration when ‘flow_data.type=subscription_update`.



247
248
249
# File 'lib/stripe/resources/billing_portal/session.rb', line 247

def subscription_update
  @subscription_update
end

#subscription_update_confirmObject

Configuration when ‘flow_data.type=subscription_update_confirm`.



250
251
252
# File 'lib/stripe/resources/billing_portal/session.rb', line 250

def subscription_update_confirm
  @subscription_update_confirm
end

#typeObject

Type of flow that the customer will go through.



253
254
255
# File 'lib/stripe/resources/billing_portal/session.rb', line 253

def type
  @type
end