Class: Stripe::InvoicePaymentListParams

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

Defined Under Namespace

Classes: Created, Payment

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(created: nil, ending_before: nil, expand: nil, invoice: nil, limit: nil, payment: nil, starting_after: nil, status: nil) ⇒ InvoicePaymentListParams

Returns a new instance of InvoicePaymentListParams.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 55

def initialize(
  created: nil,
  ending_before: nil,
  expand: nil,
  invoice: nil,
  limit: nil,
  payment: nil,
  starting_after: nil,
  status: nil
)
  @created = created
  @ending_before = ending_before
  @expand = expand
  @invoice = invoice
  @limit = limit
  @payment = payment
  @starting_after = starting_after
  @status = status
end

Instance Attribute Details

#created ⇒ Object

Only return invoice payments that were created during the given date interval.



39
40
41
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 39

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



41
42
43
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 41

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



43
44
45
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 43

def expand
  @expand
end

#invoice ⇒ Object

The identifier of the invoice whose payments to return.



45
46
47
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 45

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



47
48
49
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 47

def limit
  @limit
end

#payment ⇒ Object

The payment details of the invoice payments to return.



49
50
51
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 49

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



51
52
53
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 51

def starting_after
  @starting_after
end

#status ⇒ Object

The status of the invoice payments to return.



53
54
55
 
# File 'lib/stripe/params/invoice_payment_list_params.rb', line 53

def status
  @status
end