Class: Stripe::QuoteListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/quote_list_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(customer: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil, status: nil, test_clock: nil) ⇒ QuoteListParams

Returns a new instance of QuoteListParams.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/stripe/params/quote_list_params.rb', line 21

def initialize(
  customer: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  starting_after: nil,
  status: nil,
  test_clock: nil
)
  @customer = customer
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @starting_after = starting_after
  @status = status
  @test_clock = test_clock
end

Instance Attribute Details

#customer ⇒ Object

The ID of the customer whose quotes will be retrieved.



7
8
9
 
# File 'lib/stripe/params/quote_list_params.rb', line 7

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



9
10
11
 
# File 'lib/stripe/params/quote_list_params.rb', line 9

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



11
12
13
 
# File 'lib/stripe/params/quote_list_params.rb', line 11

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.



13
14
15
 
# File 'lib/stripe/params/quote_list_params.rb', line 13

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.



15
16
17
 
# File 'lib/stripe/params/quote_list_params.rb', line 15

def starting_after
  @starting_after
end

#status ⇒ Object

The status of the quote.



17
18
19
 
# File 'lib/stripe/params/quote_list_params.rb', line 17

def status
  @status
end

#test_clock ⇒ Object

Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.



19
20
21
 
# File 'lib/stripe/params/quote_list_params.rb', line 19

def test_clock
  @test_clock
end