Class: ChargeBee::Plan

Inherits:
Model
  • Object
show all
Defined in:
lib/chargebee/models/plan.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Model

construct, #init_dependant, #init_dependant_list, #initialize, #inspect, #load, #method_missing, #to_s, uri_path

Constructor Details

This class inherits a constructor from ChargeBee::Model

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ChargeBee::Model

Instance Attribute Details

#accounting_category1 ⇒ Object

Returns the value of attribute accounting_category1.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def accounting_category1
  @accounting_category1
end

#accounting_category2 ⇒ Object

Returns the value of attribute accounting_category2.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def accounting_category2
  @accounting_category2
end

#accounting_code ⇒ Object

Returns the value of attribute accounting_code.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def accounting_code
  @accounting_code
end

#archived_at ⇒ Object

Returns the value of attribute archived_at.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def archived_at
  @archived_at
end

#billing_cycles ⇒ Object

Returns the value of attribute billing_cycles.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def billing_cycles
  @billing_cycles
end

#charge_model ⇒ Object

Returns the value of attribute charge_model.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def charge_model
  @charge_model
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def currency_code
  @currency_code
end

#description ⇒ Object

Returns the value of attribute description.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def description
  @description
end

#downgrade_penalty ⇒ Object

Returns the value of attribute downgrade_penalty.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def downgrade_penalty
  @downgrade_penalty
end

#enabled_in_hosted_pages ⇒ Object

Returns the value of attribute enabled_in_hosted_pages.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def enabled_in_hosted_pages
  @enabled_in_hosted_pages
end

#enabled_in_portal ⇒ Object

Returns the value of attribute enabled_in_portal.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def enabled_in_portal
  @enabled_in_portal
end

#free_quantity ⇒ Object

Returns the value of attribute free_quantity.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def free_quantity
  @free_quantity
end

#id ⇒ Object

Returns the value of attribute id.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def id
  @id
end

#invoice_name ⇒ Object

Returns the value of attribute invoice_name.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def invoice_name
  @invoice_name
end

#invoice_notes ⇒ Object

Returns the value of attribute invoice_notes.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def invoice_notes
  @invoice_notes
end

#meta_data ⇒ Object

Returns the value of attribute meta_data.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def meta_data
  @meta_data
end

#name ⇒ Object

Returns the value of attribute name.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def name
  @name
end

#period ⇒ Object

Returns the value of attribute period.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def period
  @period
end

#period_unit ⇒ Object

Returns the value of attribute period_unit.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def period_unit
  @period_unit
end

#price ⇒ Object

Returns the value of attribute price.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def price
  @price
end

#redirect_url ⇒ Object

Returns the value of attribute redirect_url.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def redirect_url
  @redirect_url
end

#resource_version ⇒ Object

Returns the value of attribute resource_version.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def resource_version
  @resource_version
end

#setup_cost ⇒ Object

Returns the value of attribute setup_cost.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def setup_cost
  @setup_cost
end

#sku ⇒ Object

Returns the value of attribute sku.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def sku
  @sku
end

#status ⇒ Object

Returns the value of attribute status.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def status
  @status
end

#tax_code ⇒ Object

Returns the value of attribute tax_code.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def tax_code
  @tax_code
end

#tax_profile_id ⇒ Object

Returns the value of attribute tax_profile_id.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def tax_profile_id
  @tax_profile_id
end

#taxable ⇒ Object

Returns the value of attribute taxable.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def taxable
  @taxable
end

#trial_period ⇒ Object

Returns the value of attribute trial_period.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def trial_period
  @trial_period
end

#trial_period_unit ⇒ Object

Returns the value of attribute trial_period_unit.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def trial_period_unit
  @trial_period_unit
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



4
5
6
 
# File 'lib/chargebee/models/plan.rb', line 4

def updated_at
  @updated_at
end

Class Method Details

.copy(params, env = nil, headers = {}) ⇒ Object 



33
34
35
 
# File 'lib/chargebee/models/plan.rb', line 33

def self.copy(params, env=nil, headers={})
  Request.send('post', uri_path("plans","copy"), params, env, headers)
end

.create(params, env = nil, headers = {}) ⇒ Object

OPERATIONS



13
14
15
 
# File 'lib/chargebee/models/plan.rb', line 13

def self.create(params, env=nil, headers={})
  Request.send('post', uri_path("plans"), params, env, headers)
end

.delete(id, env = nil, headers = {}) ⇒ Object 



29
30
31
 
# File 'lib/chargebee/models/plan.rb', line 29

def self.delete(id, env=nil, headers={})
  Request.send('post', uri_path("plans",id.to_s,"delete"), {}, env, headers)
end

.list(params = {}, env = nil, headers = {}) ⇒ Object 



21
22
23
 
# File 'lib/chargebee/models/plan.rb', line 21

def self.list(params={}, env=nil, headers={})
  Request.send_list_request('get', uri_path("plans"), params, env, headers)
end

.retrieve(id, env = nil, headers = {}) ⇒ Object 



25
26
27
 
# File 'lib/chargebee/models/plan.rb', line 25

def self.retrieve(id, env=nil, headers={})
  Request.send('get', uri_path("plans",id.to_s), {}, env, headers)
end

.unarchive(id, env = nil, headers = {}) ⇒ Object 



37
38
39
 
# File 'lib/chargebee/models/plan.rb', line 37

def self.unarchive(id, env=nil, headers={})
  Request.send('post', uri_path("plans",id.to_s,"unarchive"), {}, env, headers)
end

.update(id, params = {}, env = nil, headers = {}) ⇒ Object 



17
18
19
 
# File 'lib/chargebee/models/plan.rb', line 17

def self.update(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("plans",id.to_s), params, env, headers)
end