Class: Stripe::PaymentLinkService::ListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/payment_link_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, limit: nil, starting_after: nil) ⇒ ListParams

Returns a new instance of ListParams.



25
26
27
28
29
30
31
 
# File 'lib/stripe/services/payment_link_service.rb', line 25

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

Instance Attribute Details

#active ⇒ Object

Only return payment links that are active or inactive (e.g., pass ‘false` to list all inactive payment links).



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

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.



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

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



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

def expand
  @expand
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.



21
22
23
 
# File 'lib/stripe/services/payment_link_service.rb', line 21

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.



23
24
25
 
# File 'lib/stripe/services/payment_link_service.rb', line 23

def starting_after
  @starting_after
end