Class: ChargeBee::Plan

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

Defined Under Namespace

Classes: ApplicableAddon, AttachedAddon, EventBasedAddon, Tier

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.



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

def accounting_category1
  @accounting_category1
end

#accounting_category2 ⇒ Object

Returns the value of attribute accounting_category2.



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

def accounting_category2
  @accounting_category2
end

#accounting_category3 ⇒ Object

Returns the value of attribute accounting_category3.



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

def accounting_category3
  @accounting_category3
end

#accounting_category4 ⇒ Object

Returns the value of attribute accounting_category4.



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

def accounting_category4
  @accounting_category4
end

#accounting_code ⇒ Object

Returns the value of attribute accounting_code.



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

def accounting_code
  @accounting_code
end

#addon_applicability ⇒ Object

Returns the value of attribute addon_applicability.



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

def addon_applicability
  @addon_applicability
end

#applicable_addons ⇒ Object

Returns the value of attribute applicable_addons.



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

def applicable_addons
  @applicable_addons
end

#archived_at ⇒ Object

Returns the value of attribute archived_at.



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

def archived_at
  @archived_at
end

#attached_addons ⇒ Object

Returns the value of attribute attached_addons.



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

def attached_addons
  @attached_addons
end

#avalara_sale_type ⇒ Object

Returns the value of attribute avalara_sale_type.



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

def avalara_sale_type
  @avalara_sale_type
end

#avalara_service_type ⇒ Object

Returns the value of attribute avalara_service_type.



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

def avalara_service_type
  @avalara_service_type
end

#avalara_transaction_type ⇒ Object

Returns the value of attribute avalara_transaction_type.



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

def avalara_transaction_type
  @avalara_transaction_type
end

#billing_cycles ⇒ Object

Returns the value of attribute billing_cycles.



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

def billing_cycles
  @billing_cycles
end

#channel ⇒ Object

Returns the value of attribute channel.



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

def channel
  @channel
end

#charge_model ⇒ Object

Returns the value of attribute charge_model.



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

def charge_model
  @charge_model
end

#claim_url ⇒ Object

Returns the value of attribute claim_url.



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

def claim_url
  @claim_url
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#downgrade_penalty ⇒ Object

Returns the value of attribute downgrade_penalty.



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

def downgrade_penalty
  @downgrade_penalty
end

#enabled_in_hosted_pages ⇒ Object

Returns the value of attribute enabled_in_hosted_pages.



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

def enabled_in_hosted_pages
  @enabled_in_hosted_pages
end

#enabled_in_portal ⇒ Object

Returns the value of attribute enabled_in_portal.



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

def enabled_in_portal
  @enabled_in_portal
end

#event_based_addons ⇒ Object

Returns the value of attribute event_based_addons.



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

def event_based_addons
  @event_based_addons
end

#free_quantity ⇒ Object

Returns the value of attribute free_quantity.



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

def free_quantity
  @free_quantity
end

#free_quantity_in_decimal ⇒ Object

Returns the value of attribute free_quantity_in_decimal.



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

def free_quantity_in_decimal
  @free_quantity_in_decimal
end

#giftable ⇒ Object

Returns the value of attribute giftable.



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

def giftable
  @giftable
end

#hsn_code ⇒ Object

Returns the value of attribute hsn_code.



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

def hsn_code
  @hsn_code
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#invoice_name ⇒ Object

Returns the value of attribute invoice_name.



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

def invoice_name
  @invoice_name
end

#invoice_notes ⇒ Object

Returns the value of attribute invoice_notes.



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

def invoice_notes
  @invoice_notes
end

#is_shippable ⇒ Object

Returns the value of attribute is_shippable.



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

def is_shippable
  @is_shippable
end

#meta_data ⇒ Object

Returns the value of attribute meta_data.



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

def meta_data
  @meta_data
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#period ⇒ Object

Returns the value of attribute period.



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

def period
  @period
end

#period_unit ⇒ Object

Returns the value of attribute period_unit.



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

def period_unit
  @period_unit
end

#price ⇒ Object

Returns the value of attribute price.



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

def price
  @price
end

#price_in_decimal ⇒ Object

Returns the value of attribute price_in_decimal.



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

def price_in_decimal
  @price_in_decimal
end

#pricing_model ⇒ Object

Returns the value of attribute pricing_model.



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

def pricing_model
  @pricing_model
end

#redirect_url ⇒ Object

Returns the value of attribute redirect_url.



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

def redirect_url
  @redirect_url
end

#resource_version ⇒ Object

Returns the value of attribute resource_version.



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

def resource_version
  @resource_version
end

#setup_cost ⇒ Object

Returns the value of attribute setup_cost.



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

def setup_cost
  @setup_cost
end

#shipping_frequency_period ⇒ Object

Returns the value of attribute shipping_frequency_period.



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

def shipping_frequency_period
  @shipping_frequency_period
end

#shipping_frequency_period_unit ⇒ Object

Returns the value of attribute shipping_frequency_period_unit.



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

def shipping_frequency_period_unit
  @shipping_frequency_period_unit
end

#show_description_in_invoices ⇒ Object

Returns the value of attribute show_description_in_invoices.



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

def show_description_in_invoices
  @show_description_in_invoices
end

#show_description_in_quotes ⇒ Object

Returns the value of attribute show_description_in_quotes.



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

def show_description_in_quotes
  @show_description_in_quotes
end

#sku ⇒ Object

Returns the value of attribute sku.



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

def sku
  @sku
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#tax_code ⇒ Object

Returns the value of attribute tax_code.



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

def tax_code
  @tax_code
end

#tax_profile_id ⇒ Object

Returns the value of attribute tax_profile_id.



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

def tax_profile_id
  @tax_profile_id
end

#taxable ⇒ Object

Returns the value of attribute taxable.



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

def taxable
  @taxable
end

#taxjar_product_code ⇒ Object

Returns the value of attribute taxjar_product_code.



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

def taxjar_product_code
  @taxjar_product_code
end

#tiers ⇒ Object

Returns the value of attribute tiers.



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

def tiers
  @tiers
end

#trial_end_action ⇒ Object

Returns the value of attribute trial_end_action.



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

def trial_end_action
  @trial_end_action
end

#trial_period ⇒ Object

Returns the value of attribute trial_period.



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

def trial_period
  @trial_period
end

#trial_period_unit ⇒ Object

Returns the value of attribute trial_period_unit.



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

def trial_period_unit
  @trial_period_unit
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

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



53
54
55
 
# File 'lib/chargebee/models/plan.rb', line 53

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



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

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

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



49
50
51
 
# File 'lib/chargebee/models/plan.rb', line 49

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 



41
42
43
 
# File 'lib/chargebee/models/plan.rb', line 41

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 



45
46
47
 
# File 'lib/chargebee/models/plan.rb', line 45

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 



57
58
59
 
# File 'lib/chargebee/models/plan.rb', line 57

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 



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

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