Class: ChargeBee::Addon
Defined Under Namespace
Classes: TaxProvidersField, Tier
Instance Attribute Summary collapse
- 
  
    
      #accounting_category1  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute accounting_category1.
 - 
  
    
      #accounting_category2  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute accounting_category2.
 - 
  
    
      #accounting_category3  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute accounting_category3.
 - 
  
    
      #accounting_category4  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute accounting_category4.
 - 
  
    
      #accounting_code  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute accounting_code.
 - 
  
    
      #archived_at  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute archived_at.
 - 
  
    
      #avalara_sale_type  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute avalara_sale_type.
 - 
  
    
      #avalara_service_type  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute avalara_service_type.
 - 
  
    
      #avalara_transaction_type  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute avalara_transaction_type.
 - 
  
    
      #channel  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute channel.
 - 
  
    
      #charge_type  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute charge_type.
 - 
  
    
      #currency_code  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute currency_code.
 - 
  
    
      #description  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute description.
 - 
  
    
      #enabled_in_portal  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute enabled_in_portal.
 - 
  
    
      #hsn_code  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute hsn_code.
 - 
  
    
      #id  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute id.
 - 
  
    
      #included_in_mrr  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute included_in_mrr.
 - 
  
    
      #invoice_name  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute invoice_name.
 - 
  
    
      #invoice_notes  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute invoice_notes.
 - 
  
    
      #is_shippable  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute is_shippable.
 - 
  
    
      #meta_data  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute meta_data.
 - 
  
    
      #name  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute name.
 - 
  
    
      #period  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute period.
 - 
  
    
      #period_unit  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute period_unit.
 - 
  
    
      #price  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute price.
 - 
  
    
      #price_in_decimal  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute price_in_decimal.
 - 
  
    
      #pricing_model  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute pricing_model.
 - 
  
    
      #proration_type  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute proration_type.
 - 
  
    
      #resource_version  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute resource_version.
 - 
  
    
      #shipping_frequency_period  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute shipping_frequency_period.
 - 
  
    
      #shipping_frequency_period_unit  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute shipping_frequency_period_unit.
 - 
  
    
      #show_description_in_invoices  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute show_description_in_invoices.
 - 
  
    
      #show_description_in_quotes  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute show_description_in_quotes.
 - 
  
    
      #sku  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute sku.
 - 
  
    
      #status  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute status.
 - 
  
    
      #tax_code  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute tax_code.
 - 
  
    
      #tax_profile_id  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute tax_profile_id.
 - 
  
    
      #tax_providers_fields  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute tax_providers_fields.
 - 
  
    
      #taxable  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute taxable.
 - 
  
    
      #taxjar_product_code  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute taxjar_product_code.
 - 
  
    
      #tiers  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute tiers.
 - 
  
    
      #type  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute type.
 - 
  
    
      #unit  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute unit.
 - 
  
    
      #updated_at  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute updated_at.
 
Class Method Summary collapse
- .copy(params, env = nil, headers = {}) ⇒ Object
 - 
  
    
      .create(params, env = nil, headers = {})  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
OPERATIONS ———–.
 - .delete(id, env = nil, headers = {}) ⇒ Object
 - .list(params = {}, env = nil, headers = {}) ⇒ Object
 - .retrieve(id, env = nil, headers = {}) ⇒ Object
 - .unarchive(id, env = nil, headers = {}) ⇒ Object
 - .update(id, params, env = nil, headers = {}) ⇒ Object
 
Methods inherited from Model
construct, #init_dependant, #init_dependant_list, #initialize, #inspect, #load, #method_missing, #replace_white_space_with_underscore, #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.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def accounting_category1 @accounting_category1 end  | 
  
#accounting_category2 ⇒ Object
Returns the value of attribute accounting_category2.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def accounting_category2 @accounting_category2 end  | 
  
#accounting_category3 ⇒ Object
Returns the value of attribute accounting_category3.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def accounting_category3 @accounting_category3 end  | 
  
#accounting_category4 ⇒ Object
Returns the value of attribute accounting_category4.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def accounting_category4 @accounting_category4 end  | 
  
#accounting_code ⇒ Object
Returns the value of attribute accounting_code.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def accounting_code @accounting_code end  | 
  
#archived_at ⇒ Object
Returns the value of attribute archived_at.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def archived_at @archived_at end  | 
  
#avalara_sale_type ⇒ Object
Returns the value of attribute avalara_sale_type.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def avalara_sale_type @avalara_sale_type end  | 
  
#avalara_service_type ⇒ Object
Returns the value of attribute avalara_service_type.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def avalara_service_type @avalara_service_type end  | 
  
#avalara_transaction_type ⇒ Object
Returns the value of attribute avalara_transaction_type.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def avalara_transaction_type @avalara_transaction_type end  | 
  
#channel ⇒ Object
Returns the value of attribute channel.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def channel @channel end  | 
  
#charge_type ⇒ Object
Returns the value of attribute charge_type.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def charge_type @charge_type end  | 
  
#currency_code ⇒ Object
Returns the value of attribute currency_code.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def currency_code @currency_code end  | 
  
#description ⇒ Object
Returns the value of attribute description.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def description @description end  | 
  
#enabled_in_portal ⇒ Object
Returns the value of attribute enabled_in_portal.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def enabled_in_portal @enabled_in_portal end  | 
  
#hsn_code ⇒ Object
Returns the value of attribute hsn_code.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def hsn_code @hsn_code end  | 
  
#id ⇒ Object
Returns the value of attribute id.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def id @id end  | 
  
#included_in_mrr ⇒ Object
Returns the value of attribute included_in_mrr.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def included_in_mrr @included_in_mrr end  | 
  
#invoice_name ⇒ Object
Returns the value of attribute invoice_name.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def invoice_name @invoice_name end  | 
  
#invoice_notes ⇒ Object
Returns the value of attribute invoice_notes.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def invoice_notes @invoice_notes end  | 
  
#is_shippable ⇒ Object
Returns the value of attribute is_shippable.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def is_shippable @is_shippable end  | 
  
#meta_data ⇒ Object
Returns the value of attribute meta_data.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def @meta_data end  | 
  
#name ⇒ Object
Returns the value of attribute name.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def name @name end  | 
  
#period ⇒ Object
Returns the value of attribute period.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def period @period end  | 
  
#period_unit ⇒ Object
Returns the value of attribute period_unit.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def period_unit @period_unit end  | 
  
#price ⇒ Object
Returns the value of attribute price.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def price @price end  | 
  
#price_in_decimal ⇒ Object
Returns the value of attribute price_in_decimal.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def price_in_decimal @price_in_decimal end  | 
  
#pricing_model ⇒ Object
Returns the value of attribute pricing_model.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def pricing_model @pricing_model end  | 
  
#proration_type ⇒ Object
Returns the value of attribute proration_type.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def proration_type @proration_type end  | 
  
#resource_version ⇒ Object
Returns the value of attribute resource_version.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def resource_version @resource_version end  | 
  
#shipping_frequency_period ⇒ Object
Returns the value of attribute shipping_frequency_period.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def shipping_frequency_period @shipping_frequency_period end  | 
  
#shipping_frequency_period_unit ⇒ Object
Returns the value of attribute shipping_frequency_period_unit.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def shipping_frequency_period_unit @shipping_frequency_period_unit end  | 
  
#show_description_in_invoices ⇒ Object
Returns the value of attribute show_description_in_invoices.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def show_description_in_invoices @show_description_in_invoices end  | 
  
#show_description_in_quotes ⇒ Object
Returns the value of attribute show_description_in_quotes.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def show_description_in_quotes @show_description_in_quotes end  | 
  
#sku ⇒ Object
Returns the value of attribute sku.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def sku @sku end  | 
  
#status ⇒ Object
Returns the value of attribute status.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def status @status end  | 
  
#tax_code ⇒ Object
Returns the value of attribute tax_code.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def tax_code @tax_code end  | 
  
#tax_profile_id ⇒ Object
Returns the value of attribute tax_profile_id.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def tax_profile_id @tax_profile_id end  | 
  
#tax_providers_fields ⇒ Object
Returns the value of attribute tax_providers_fields.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def tax_providers_fields @tax_providers_fields end  | 
  
#taxable ⇒ Object
Returns the value of attribute taxable.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def taxable @taxable end  | 
  
#taxjar_product_code ⇒ Object
Returns the value of attribute taxjar_product_code.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def taxjar_product_code @taxjar_product_code end  | 
  
#tiers ⇒ Object
Returns the value of attribute tiers.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def tiers @tiers end  | 
  
#type ⇒ Object
Returns the value of attribute type.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def type @type end  | 
  
#unit ⇒ Object
Returns the value of attribute unit.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def unit @unit end  | 
  
#updated_at ⇒ Object
Returns the value of attribute updated_at.
      12 13 14  | 
    
      # File 'lib/chargebee/models/addon.rb', line 12 def updated_at @updated_at end  | 
  
Class Method Details
.copy(params, env = nil, headers = {}) ⇒ Object
      44 45 46  | 
    
      # File 'lib/chargebee/models/addon.rb', line 44 def self.copy(params, env=nil, headers={}) Request.send('post', uri_path("addons","copy"), params, env, headers) end  | 
  
.create(params, env = nil, headers = {}) ⇒ Object
OPERATIONS
      24 25 26  | 
    
      # File 'lib/chargebee/models/addon.rb', line 24 def self.create(params, env=nil, headers={}) Request.send('post', uri_path("addons"), params, env, headers) end  | 
  
.delete(id, env = nil, headers = {}) ⇒ Object
      40 41 42  | 
    
      # File 'lib/chargebee/models/addon.rb', line 40 def self.delete(id, env=nil, headers={}) Request.send('post', uri_path("addons",id.to_s,"delete"), {}, env, headers) end  | 
  
.list(params = {}, env = nil, headers = {}) ⇒ Object
      32 33 34  | 
    
      # File 'lib/chargebee/models/addon.rb', line 32 def self.list(params={}, env=nil, headers={}) Request.send_list_request('get', uri_path("addons"), params, env, headers) end  | 
  
.retrieve(id, env = nil, headers = {}) ⇒ Object
      36 37 38  | 
    
      # File 'lib/chargebee/models/addon.rb', line 36 def self.retrieve(id, env=nil, headers={}) Request.send('get', uri_path("addons",id.to_s), {}, env, headers) end  |