Class: Stripe::Checkout::SessionListParams

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

Defined Under Namespace

Classes: Created, CustomerDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, discriminator, discriminator_fields, field_encodings, new, #to_h

Constructor Details

#initialize(created: nil, customer: nil, customer_account: nil, customer_details: nil, ending_before: nil, expand: nil, limit: nil, payment_intent: nil, payment_link: nil, starting_after: nil, status: nil, subscription: nil) ⇒ SessionListParams

Returns a new instance of SessionListParams.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 58

def initialize(
  created: nil,
  customer: nil,
  customer_account: nil,
  customer_details: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  payment_intent: nil,
  payment_link: nil,
  starting_after: nil,
  status: nil,
  subscription: nil
)
  @created = created
  @customer = customer
  @customer_account = 
  @customer_details = customer_details
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @payment_intent = payment_intent
  @payment_link = payment_link
  @starting_after = starting_after
  @status = status
  @subscription = subscription
end

Instance Attribute Details

#created ⇒ Object

Only return Checkout Sessions that were created during the given date interval.



34
35
36
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 34

def created
  @created
end

#customer ⇒ Object

Only return the Checkout Sessions for the Customer specified.



36
37
38
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 36

def customer
  @customer
end

#customer_account ⇒ Object

Only return the Checkout Sessions for the Account specified.



38
39
40
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 38

def 
  @customer_account
end

#customer_details ⇒ Object

Only return the Checkout Sessions for the Customer details specified.



40
41
42
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 40

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



42
43
44
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 42

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



44
45
46
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 44

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.



46
47
48
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 46

def limit
  @limit
end

#payment_intent ⇒ Object

Only return the Checkout Session for the PaymentIntent specified.



48
49
50
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 48

def payment_intent
  @payment_intent
end

#payment_link ⇒ Object

Only return the Checkout Sessions for the Payment Link specified.



50
51
52
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 50

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



52
53
54
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 52

def starting_after
  @starting_after
end

#status ⇒ Object

Only return the Checkout Sessions matching the given status.



54
55
56
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 54

def status
  @status
end

#subscription ⇒ Object

Only return the Checkout Session for the subscription specified.



56
57
58
 
# File 'lib/stripe/params/checkout/session_list_params.rb', line 56

def subscription
  @subscription
end