Class: Stripe::SubscriptionScheduleListParams

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

Defined Under Namespace

Classes: CanceledAt, CompletedAt, Created, ReleasedAt

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(canceled_at: nil, completed_at: nil, created: nil, customer: nil, ending_before: nil, expand: nil, limit: nil, released_at: nil, scheduled: nil, starting_after: nil) ⇒ SubscriptionScheduleListParams

Returns a new instance of SubscriptionScheduleListParams.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 98

def initialize(
  canceled_at: nil,
  completed_at: nil,
  created: nil,
  customer: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  released_at: nil,
  scheduled: nil,
  starting_after: nil
)
  @canceled_at = canceled_at
  @completed_at = completed_at
  @created = created
  @customer = customer
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @released_at = released_at
  @scheduled = scheduled
  @starting_after = starting_after
end

Instance Attribute Details

#canceled_at ⇒ Object

Only return subscription schedules that were created canceled the given date interval.



78
79
80
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 78

def canceled_at
  @canceled_at
end

#completed_at ⇒ Object

Only return subscription schedules that completed during the given date interval.



80
81
82
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 80

def completed_at
  @completed_at
end

#created ⇒ Object

Only return subscription schedules that were created during the given date interval.



82
83
84
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 82

def created
  @created
end

#customer ⇒ Object

Only return subscription schedules for the given customer.



84
85
86
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 84

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.



86
87
88
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 86

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



88
89
90
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 88

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.



90
91
92
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 90

def limit
  @limit
end

#released_at ⇒ Object

Only return subscription schedules that were released during the given date interval.



92
93
94
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 92

def released_at
  @released_at
end

#scheduled ⇒ Object

Only return subscription schedules that have not started yet.



94
95
96
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 94

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



96
97
98
 
# File 'lib/stripe/params/subscription_schedule_list_params.rb', line 96

def starting_after
  @starting_after
end