Class: Stripe::SubscriptionScheduleService::ListParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/subscription_schedule_service.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) ⇒ ListParams

Returns a new instance of ListParams.



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

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.



79
80
81
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 79

def canceled_at
  @canceled_at
end

#completed_at ⇒ Object

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



81
82
83
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 81

def completed_at
  @completed_at
end

#created ⇒ Object

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



83
84
85
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 83

def created
  @created
end

#customer ⇒ Object

Only return subscription schedules for the given customer.



85
86
87
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 85

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.



87
88
89
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 87

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



89
90
91
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 89

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.



91
92
93
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 91

def limit
  @limit
end

#released_at ⇒ Object

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



93
94
95
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 93

def released_at
  @released_at
end

#scheduled ⇒ Object

Only return subscription schedules that have not started yet.



95
96
97
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 95

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.



97
98
99
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 97

def starting_after
  @starting_after
end