Class: Stripe::SubscriptionItemService::ListParams

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

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

Returns a new instance of ListParams.



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/stripe/services/subscription_item_service.rb', line 159

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

Instance Attribute Details

#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.



149
150
151
 
# File 'lib/stripe/services/subscription_item_service.rb', line 149

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



151
152
153
 
# File 'lib/stripe/services/subscription_item_service.rb', line 151

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.



153
154
155
 
# File 'lib/stripe/services/subscription_item_service.rb', line 153

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.



155
156
157
 
# File 'lib/stripe/services/subscription_item_service.rb', line 155

def starting_after
  @starting_after
end

#subscription ⇒ Object

The ID of the subscription whose items will be retrieved.



157
158
159
 
# File 'lib/stripe/services/subscription_item_service.rb', line 157

def subscription
  @subscription
end