Class: Stripe::Plan::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/plan.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, expand: nil, metadata: nil, nickname: nil, product: nil, trial_period_days: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/stripe/resources/plan.rb', line 80

def initialize(
  active: nil,
  expand: nil,
  metadata: nil,
  nickname: nil,
  product: nil,
  trial_period_days: nil
)
  @active = active
  @expand = expand
  @metadata = metadata
  @nickname = nickname
  @product = product
  @trial_period_days = trial_period_days
end

Instance Attribute Details

#active ⇒ Object

Whether the plan is currently available for new subscriptions.



63
64
65
 
# File 'lib/stripe/resources/plan.rb', line 63

def active
  @active
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



66
67
68
 
# File 'lib/stripe/resources/plan.rb', line 66

def expand
  @expand
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



69
70
71
 
# File 'lib/stripe/resources/plan.rb', line 69

def metadata
  @metadata
end

#nickname ⇒ Object

A brief description of the plan, hidden from customers.



72
73
74
 
# File 'lib/stripe/resources/plan.rb', line 72

def nickname
  @nickname
end

#product ⇒ Object

The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.



75
76
77
 
# File 'lib/stripe/resources/plan.rb', line 75

def product
  @product
end

#trial_period_days ⇒ Object

Default number of trial days when subscribing a customer to this plan using [‘trial_from_plan=true`](stripe.com/docs/api#create_subscription-trial_from_plan).



78
79
80
 
# File 'lib/stripe/resources/plan.rb', line 78

def trial_period_days
  @trial_period_days
end