Class: Stripe::PriceListParams

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

Defined Under Namespace

Classes: Created, Recurring

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, created: nil, currency: nil, ending_before: nil, expand: nil, limit: nil, lookup_keys: nil, product: nil, recurring: nil, starting_after: nil, type: nil) ⇒ PriceListParams

Returns a new instance of PriceListParams.



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

def initialize(
  active: nil,
  created: nil,
  currency: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  lookup_keys: nil,
  product: nil,
  recurring: nil,
  starting_after: nil,
  type: nil
)
  @active = active
  @created = created
  @currency = currency
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @lookup_keys = lookup_keys
  @product = product
  @recurring = recurring
  @starting_after = starting_after
  @type = type
end

Instance Attribute Details

#active ⇒ Object

Only return prices that are active or inactive (e.g., pass ‘false` to list all inactive prices).



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

def active
  @active
end

#created ⇒ Object

A filter on the list, based on the object ‘created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.



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

def created
  @created
end

#currency ⇒ Object

Only return prices for the given currency.



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

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



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

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



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

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.



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

def limit
  @limit
end

#lookup_keys ⇒ Object

Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.



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

def lookup_keys
  @lookup_keys
end

#product ⇒ Object

Only return prices for the given product.



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

def product
  @product
end

#recurring ⇒ Object

Only return prices with these recurring fields.



55
56
57
 
# File 'lib/stripe/params/price_list_params.rb', line 55

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



57
58
59
 
# File 'lib/stripe/params/price_list_params.rb', line 57

def starting_after
  @starting_after
end

#type ⇒ Object

Only return prices of type ‘recurring` or `one_time`.



59
60
61
 
# File 'lib/stripe/params/price_list_params.rb', line 59

def type
  @type
end