Class: Stripe::BillingPortal::Configuration::UpdateParams

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(active: nil, business_profile: nil, default_return_url: nil, expand: nil, features: nil, login_page: nil, metadata: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 534

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

Instance Attribute Details

#active ⇒ Object

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



520
521
522
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 520

def active
  @active
end

#business_profile ⇒ Object

The business information shown to customers in the portal.



522
523
524
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 522

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.



524
525
526
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 524

def default_return_url
  @default_return_url
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



526
527
528
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 526

def expand
  @expand
end

#features ⇒ Object

Information about the features available in the portal.



528
529
530
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 528

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).



530
531
532
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 530

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`.



532
533
534
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 532

def metadata
  @metadata
end