Class: Stripe::BillingPortal::Configuration

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/billing_portal/configuration.rb

Overview

A portal configuration describes the functionality and behavior of a portal session.

Defined Under Namespace

Classes: BusinessProfile, CreateParams, Features, ListParams, LoginPage, RetrieveParams, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"billing_portal.configuration"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#active ⇒ Object (readonly)

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



618
619
620
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 618

def active
  @active
end

#application ⇒ Object (readonly)

ID of the Connect Application that created the configuration.



621
622
623
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 621

def application
  @application
end

#business_profile ⇒ Object (readonly)

Attribute for field business_profile



624
625
626
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 624

def business_profile
  @business_profile
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



627
628
629
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 627

def created
  @created
end

#default_return_url ⇒ Object (readonly)

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.



630
631
632
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 630

def default_return_url
  @default_return_url
end

#features ⇒ Object (readonly)

Attribute for field features



633
634
635
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 633

def features
  @features
end

#id ⇒ Object (readonly)

Unique identifier for the object.



636
637
638
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 636

def id
  @id
end

#is_default ⇒ Object (readonly)

Whether the configuration is the default. If ‘true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.



639
640
641
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 639

def is_default
  @is_default
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



642
643
644
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 642

def livemode
  @livemode
end

#login_page ⇒ Object (readonly)

Attribute for field login_page



645
646
647
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 645

def 
  @login_page
end

#metadata ⇒ Object (readonly)

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.



648
649
650
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 648

def metadata
  @metadata
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



651
652
653
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 651

def object
  @object
end

#updated ⇒ Object (readonly)

Time at which the object was last updated. Measured in seconds since the Unix epoch.



654
655
656
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 654

def updated
  @updated
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a configuration that describes the functionality and behavior of a PortalSession



657
658
659
660
661
662
663
664
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 657

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/billing_portal/configurations",
    params: params,
    opts: opts
  )
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of configurations that describe the functionality of the customer portal.



667
668
669
670
671
672
673
674
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 667

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/billing_portal/configurations",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



13
14
15
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 13

def self.object_name
  "billing_portal.configuration"
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates a configuration that describes the functionality of the customer portal.



677
678
679
680
681
682
683
684
 
# File 'lib/stripe/resources/billing_portal/configuration.rb', line 677

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/billing_portal/configurations/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end