Class: Stripe::BillingPortal::Configuration::CreateParams

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

Defined Under Namespace

Classes: BusinessProfile, Features, LoginPage

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(business_profile: nil, default_return_url: nil, expand: nil, features: nil, login_page: nil, metadata: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 322

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

Instance Attribute Details

#business_profile ⇒ Object

The business information shown to customers in the portal.



310
311
312
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 310

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](stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.



312
313
314
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 312

def default_return_url
  @default_return_url
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



314
315
316
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 314

def expand
  @expand
end

#features ⇒ Object

Information about the features available in the portal.



316
317
318
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 316

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](stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).



318
319
320
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 318

def 
  @login_page
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) 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`.



320
321
322
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 320

def metadata
  @metadata
end