Class: Stripe::BillingPortal::ConfigurationUpdateParams

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

Defined Under Namespace

Classes: BusinessProfile, Features, LoginPage

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(active: nil, business_profile: nil, default_return_url: nil, expand: nil, features: nil, login_page: nil, metadata: nil, name: nil) ⇒ ConfigurationUpdateParams 



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 217

def initialize(
  active: nil,
  business_profile: nil,
  default_return_url: nil,
  expand: nil,
  features: nil,
  login_page: nil,
  metadata: nil,
  name: nil
)
  @active = active
  @business_profile = business_profile
  @default_return_url = default_return_url
  @expand = expand
  @features = features
  @login_page = 
  @metadata = metadata
  @name = name
end

Instance Attribute Details

#active ⇒ Object

Whether the configuration is active and can be used to create portal sessions.



201
202
203
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 201

def active
  @active
end

#business_profile ⇒ Object

The business information shown to customers in the portal.



203
204
205
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 203

def business_profile
  @business_profile
end

#default_return_url ⇒ Object

The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.



205
206
207
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 205

def default_return_url
  @default_return_url
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



207
208
209
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 207

def expand
  @expand
end

#features ⇒ Object

Information about the features available in the portal.



209
210
211
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 209

def features
  @features
end

#login_page ⇒ Object

The hosted login page for this configuration. Learn more about the portal login page in our integration docs.



211
212
213
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 211

def 
  @login_page
end

#metadata ⇒ Object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.



213
214
215
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 213

def metadata
  @metadata
end

#name ⇒ Object

The name of the configuration.



215
216
217
 
# File 'lib/stripe/params/billing_portal/configuration_update_params.rb', line 215

def name
  @name
end