Class: Stripe::Subscription::SearchParams

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(expand: nil, limit: nil, page: nil, query: nil) ⇒ SearchParams

Returns a new instance of SearchParams.



1861
1862
1863
1864
1865
1866
 
# File 'lib/stripe/resources/subscription.rb', line 1861

def initialize(expand: nil, limit: nil, page: nil, query: nil)
  @expand = expand
  @limit = limit
  @page = page
  @query = query
end

Instance Attribute Details

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1853
1854
1855
 
# File 'lib/stripe/resources/subscription.rb', line 1853

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.



1855
1856
1857
 
# File 'lib/stripe/resources/subscription.rb', line 1855

def limit
  @limit
end

#page ⇒ Object

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.



1857
1858
1859
 
# File 'lib/stripe/resources/subscription.rb', line 1857

def page
  @page
end

#query ⇒ Object

The search query string. See [search query language](stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](stripe.com/docs/search#query-fields-for-subscriptions).



1859
1860
1861
 
# File 'lib/stripe/resources/subscription.rb', line 1859

def query
  @query
end