Class: Stripe::V2::Billing::PricingPlanSubscriptionListParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb

Defined Under Namespace

Classes: Payer

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

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

Constructor Details

#initialize(billing_cadence: nil, include: nil, limit: nil, payer: nil, pricing_plan: nil, pricing_plan_version: nil, servicing_status: nil) ⇒ PricingPlanSubscriptionListParams

Returns a new instance of PricingPlanSubscriptionListParams.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb', line 34

def initialize(
  billing_cadence: nil,
  include: nil,
  limit: nil,
  payer: nil,
  pricing_plan: nil,
  pricing_plan_version: nil,
  servicing_status: nil
)
  @billing_cadence = billing_cadence
  @include = include
  @limit = limit
  @payer = payer
  @pricing_plan = pricing_plan
  @pricing_plan_version = pricing_plan_version
  @servicing_status = servicing_status
end

Instance Attribute Details

#billing_cadence ⇒ Object

Filter by Billing Cadence ID. Mutually exclusive with ‘payer`, `pricing_plan`, and `pricing_plan_version`.



20
21
22
 
# File 'lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb', line 20

def billing_cadence
  @billing_cadence
end

#include ⇒ Object

Expand to include additional data such as discount_details, billing_cadence_details, or pricing_plan_component_details.



22
23
24
 
# File 'lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb', line 22

def include
  @include
end

#limit ⇒ Object

Optionally set the maximum number of results per page. Defaults to 20.



24
25
26
 
# File 'lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb', line 24

def limit
  @limit
end

#payer ⇒ Object

Filter by payer. Mutually exclusive with ‘billing_cadence`, `pricing_plan`, and `pricing_plan_version`.



26
27
28
 
# File 'lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb', line 26

def payer
  @payer
end

#pricing_plan ⇒ Object

Filter by PricingPlan ID. Mutually exclusive with ‘billing_cadence`, `payer`, and `pricing_plan_version`.



28
29
30
 
# File 'lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb', line 28

def pricing_plan
  @pricing_plan
end

#pricing_plan_version ⇒ Object

Filter by Pricing Plan Version ID. Mutually exclusive with ‘billing_cadence`, `payer`, and `pricing_plan`.



30
31
32
 
# File 'lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb', line 30

def pricing_plan_version
  @pricing_plan_version
end

#servicing_status ⇒ Object

Filter by servicing status.



32
33
34
 
# File 'lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb', line 32

def servicing_status
  @servicing_status
end