Class: Stripe::SubscriptionService::ListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/subscription_service.rb

Defined Under Namespace

Classes: AutomaticTax, Created, CurrentPeriodEnd, CurrentPeriodStart

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(automatic_tax: nil, collection_method: nil, created: nil, current_period_end: nil, current_period_start: nil, customer: nil, customer_account: nil, ending_before: nil, expand: nil, limit: nil, plan: nil, price: nil, starting_after: nil, status: nil, test_clock: nil) ⇒ ListParams

Returns a new instance of ListParams.



957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
 
# File 'lib/stripe/services/subscription_service.rb', line 957

def initialize(
  automatic_tax: nil,
  collection_method: nil,
  created: nil,
  current_period_end: nil,
  current_period_start: nil,
  customer: nil,
  customer_account: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  plan: nil,
  price: nil,
  starting_after: nil,
  status: nil,
  test_clock: nil
)
  @automatic_tax = automatic_tax
  @collection_method = collection_method
  @created = created
  @current_period_end = current_period_end
  @current_period_start = current_period_start
  @customer = customer
  @customer_account = 
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @plan = plan
  @price = price
  @starting_after = starting_after
  @status = status
  @test_clock = test_clock
end

Instance Attribute Details

#automatic_tax ⇒ Object

Filter subscriptions by their automatic tax settings.



927
928
929
 
# File 'lib/stripe/services/subscription_service.rb', line 927

def automatic_tax
  @automatic_tax
end

#collection_method ⇒ Object

The collection method of the subscriptions to retrieve. Either ‘charge_automatically` or `send_invoice`.



929
930
931
 
# File 'lib/stripe/services/subscription_service.rb', line 929

def collection_method
  @collection_method
end

#created ⇒ Object

Only return subscriptions that were created during the given date interval.



931
932
933
 
# File 'lib/stripe/services/subscription_service.rb', line 931

def created
  @created
end

#current_period_end ⇒ Object

Only return subscriptions whose minimum item current_period_end falls within the given date interval.



933
934
935
 
# File 'lib/stripe/services/subscription_service.rb', line 933

def current_period_end
  @current_period_end
end

#current_period_start ⇒ Object

Only return subscriptions whose maximum item current_period_start falls within the given date interval.



935
936
937
 
# File 'lib/stripe/services/subscription_service.rb', line 935

def current_period_start
  @current_period_start
end

#customer ⇒ Object

The ID of the customer whose subscriptions will be retrieved.



937
938
939
 
# File 'lib/stripe/services/subscription_service.rb', line 937

def customer
  @customer
end

#customer_account ⇒ Object

The ID of the account whose subscriptions will be retrieved.



939
940
941
 
# File 'lib/stripe/services/subscription_service.rb', line 939

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



941
942
943
 
# File 'lib/stripe/services/subscription_service.rb', line 941

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



943
944
945
 
# File 'lib/stripe/services/subscription_service.rb', line 943

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.



945
946
947
 
# File 'lib/stripe/services/subscription_service.rb', line 945

def limit
  @limit
end

#plan ⇒ Object

The ID of the plan whose subscriptions will be retrieved.



947
948
949
 
# File 'lib/stripe/services/subscription_service.rb', line 947

def plan
  @plan
end

#price ⇒ Object

Filter for subscriptions that contain this recurring price ID.



949
950
951
 
# File 'lib/stripe/services/subscription_service.rb', line 949

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



951
952
953
 
# File 'lib/stripe/services/subscription_service.rb', line 951

def starting_after
  @starting_after
end

#status ⇒ Object

The status of the subscriptions to retrieve. Passing in a value of ‘canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.



953
954
955
 
# File 'lib/stripe/services/subscription_service.rb', line 953

def status
  @status
end

#test_clock ⇒ Object

Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.



955
956
957
 
# File 'lib/stripe/services/subscription_service.rb', line 955

def test_clock
  @test_clock
end