Class: Stripe::BillingPortal::ConfigurationService::ListParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/billing_portal/configuration_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, ending_before: nil, expand: nil, is_default: nil, limit: nil, starting_after: nil) ⇒ ListParams

Returns a new instance of ListParams.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/stripe/services/billing_portal/configuration_service.rb', line 21

def initialize(
  active: nil,
  ending_before: nil,
  expand: nil,
  is_default: nil,
  limit: nil,
  starting_after: nil
)
  @active = active
  @ending_before = ending_before
  @expand = expand
  @is_default = is_default
  @limit = limit
  @starting_after = starting_after
end

Instance Attribute Details

#active ⇒ Object

Only return configurations that are active or inactive (e.g., pass ‘true` to only list active configurations).



9
10
11
 
# File 'lib/stripe/services/billing_portal/configuration_service.rb', line 9

def active
  @active
end

#ending_before ⇒ Object

A cursor for use in pagination. ‘ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.



11
12
13
 
# File 'lib/stripe/services/billing_portal/configuration_service.rb', line 11

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



13
14
15
 
# File 'lib/stripe/services/billing_portal/configuration_service.rb', line 13

def expand
  @expand
end

#is_default ⇒ Object

Only return the default or non-default configurations (e.g., pass ‘true` to only list the default configuration).



15
16
17
 
# File 'lib/stripe/services/billing_portal/configuration_service.rb', line 15

def is_default
  @is_default
end

#limit ⇒ Object

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.



17
18
19
 
# File 'lib/stripe/services/billing_portal/configuration_service.rb', line 17

def limit
  @limit
end

#starting_after ⇒ Object

A cursor for use in pagination. ‘starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.



19
20
21
 
# File 'lib/stripe/services/billing_portal/configuration_service.rb', line 19

def starting_after
  @starting_after
end