Class: Stripe::Charge::ListParams

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

Defined Under Namespace

Classes: Created

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(created: nil, customer: nil, ending_before: nil, expand: nil, limit: nil, payment_intent: nil, starting_after: nil, transfer_group: nil) ⇒ ListParams

Returns a new instance of ListParams.



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/stripe/resources/charge.rb', line 1202

def initialize(
  created: nil,
  customer: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  payment_intent: nil,
  starting_after: nil,
  transfer_group: nil
)
  @created = created
  @customer = customer
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @payment_intent = payment_intent
  @starting_after = starting_after
  @transfer_group = transfer_group
end

Instance Attribute Details

#created ⇒ Object

Only return charges that were created during the given date interval.



1186
1187
1188
 
# File 'lib/stripe/resources/charge.rb', line 1186

def created
  @created
end

#customer ⇒ Object

Only return charges for the customer specified by this customer ID.



1188
1189
1190
 
# File 'lib/stripe/resources/charge.rb', line 1188

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.



1190
1191
1192
 
# File 'lib/stripe/resources/charge.rb', line 1190

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1192
1193
1194
 
# File 'lib/stripe/resources/charge.rb', line 1192

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.



1194
1195
1196
 
# File 'lib/stripe/resources/charge.rb', line 1194

def limit
  @limit
end

#payment_intent ⇒ Object

Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.



1196
1197
1198
 
# File 'lib/stripe/resources/charge.rb', line 1196

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



1198
1199
1200
 
# File 'lib/stripe/resources/charge.rb', line 1198

def starting_after
  @starting_after
end

#transfer_group ⇒ Object

Only return charges for this transfer group, limited to 100.



1200
1201
1202
 
# File 'lib/stripe/resources/charge.rb', line 1200

def transfer_group
  @transfer_group
end