Class: Stripe::Quote::ListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/quote.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(customer: nil, customer_account: nil, ending_before: nil, expand: nil, from_subscription: nil, limit: nil, starting_after: nil, status: nil, test_clock: nil) ⇒ ListParams

Returns a new instance of ListParams.



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/stripe/resources/quote.rb', line 488

def initialize(
  customer: nil,
  customer_account: nil,
  ending_before: nil,
  expand: nil,
  from_subscription: nil,
  limit: nil,
  starting_after: nil,
  status: nil,
  test_clock: nil
)
  @customer = customer
  @customer_account = 
  @ending_before = ending_before
  @expand = expand
  @from_subscription = from_subscription
  @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.



470
471
472
 
# File 'lib/stripe/resources/quote.rb', line 470

def customer
  @customer
end

#customer_account ⇒ Object

The ID of the account whose quotes will be retrieved.



472
473
474
 
# File 'lib/stripe/resources/quote.rb', line 472

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



474
475
476
 
# File 'lib/stripe/resources/quote.rb', line 474

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



476
477
478
 
# File 'lib/stripe/resources/quote.rb', line 476

def expand
  @expand
end

#from_subscription ⇒ Object

The subscription which the quote updates.



478
479
480
 
# File 'lib/stripe/resources/quote.rb', line 478

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



480
481
482
 
# File 'lib/stripe/resources/quote.rb', line 480

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.



482
483
484
 
# File 'lib/stripe/resources/quote.rb', line 482

def starting_after
  @starting_after
end

#status ⇒ Object

The status of the quote.



484
485
486
 
# File 'lib/stripe/resources/quote.rb', line 484

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.



486
487
488
 
# File 'lib/stripe/resources/quote.rb', line 486

def test_clock
  @test_clock
end