Class: Recurly::Resources::AddOn

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::AddOn

Defined in:

lib/recurly/resources/add_on.rb

Instance Attribute Summary

• #accounting_code ⇒ String

  Accounting code for invoice line items for this add-on.

• #add_on_type ⇒ String

  Whether the add-on type is fixed, or usage-based.

• #avalara_service_type ⇒ Integer

  Used by Avalara for Communications taxes.

• #avalara_transaction_type ⇒ Integer

  Used by Avalara for Communications taxes.

• #code ⇒ String

  The unique identifier for the add-on within its plan.

• #created_at ⇒ DateTime

  Created at.

• #currencies ⇒ Array[AddOnPricing]

  Add-on pricing.

• #default_quantity ⇒ Integer

  Default quantity for the hosted pages.

• #deleted_at ⇒ DateTime

  Deleted at.

• #display_quantity ⇒ Boolean

  Determines if the quantity field is displayed on the hosted pages for the add-on.

• #external_sku ⇒ String

  Optional, stock keeping unit to link the item to other inventory systems.

• #harmonized_system_code ⇒ String

  The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products.

• #id ⇒ String

  Add-on ID.

• #item ⇒ ItemMini

  Just the important parts.

• #liability_gl_account_id ⇒ String

  The ID of a general ledger account.

• #measured_unit_id ⇒ String

  System-generated unique identifier for an measured unit associated with the add-on.

• #name ⇒ String

  Describes your add-on and will appear in subscribers' invoices.

• #object ⇒ String

  Object type.

• #optional ⇒ Boolean

  Whether the add-on is optional for the customer to include in their purchase on the hosted payment page.

• #percentage_tiers ⇒ Array[PercentageTiersByCurrency]

  This feature is currently in development and requires approval and enablement, please contact support.

• #performance_obligation_id ⇒ String

  The ID of a performance obligation.

• #plan_id ⇒ String

  Plan ID.

• #revenue_gl_account_id ⇒ String

  The ID of a general ledger account.

• #revenue_schedule_type ⇒ String

  When this add-on is invoiced, the line item will use this revenue schedule.

• #state ⇒ String

  Add-ons can be either active or inactive.

• #tax_code ⇒ String

  Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules.

• #tier_type ⇒ String

  The pricing model for the add-on.

• #tiers ⇒ Array[Tier]

  Tiers.

• #updated_at ⇒ DateTime

  Last updated at.

• #usage_calculation_type ⇒ String

  The type of calculation to be employed for an add-on.

• #usage_percentage ⇒ Float

  The percentage taken of the monetary amount of usage tracked.

• #usage_timeframe ⇒ String

  The time at which usage totals are reset for billing purposes.

• #usage_type ⇒ String

  Type of usage, returns usage type if add_on_type is usage.

Attributes inherited from Recurly::Resource

#attributes

Method Summary

Methods inherited from Recurly::Resource

#==, #get_response, #inspect, #requires_client?, #to_json, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#accounting_code ⇒ String

Returns Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code.

Returns:

• (String) —

  Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code.

# File 'lib/recurly/resources/add_on.rb', line 11

define_attribute :accounting_code, String

#add_on_type ⇒ String

Returns Whether the add-on type is fixed, or usage-based.

Returns:

• (String) —

  Whether the add-on type is fixed, or usage-based.

# File 'lib/recurly/resources/add_on.rb', line 15

define_attribute :add_on_type, String

#avalara_service_type ⇒ Integer

Returns Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to the documentation for more available t/s types.

Returns:

• (Integer) —

  Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to the documentation for more available t/s types.

# File 'lib/recurly/resources/add_on.rb', line 19

define_attribute :avalara_service_type, Integer

#avalara_transaction_type ⇒ Integer

Returns Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to the documentation for more available t/s types.

Returns:

• (Integer) —

  Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to the documentation for more available t/s types.

# File 'lib/recurly/resources/add_on.rb', line 23

define_attribute :avalara_transaction_type, Integer

#code ⇒ String

Returns The unique identifier for the add-on within its plan.

Returns:

• (String) —

  The unique identifier for the add-on within its plan.

# File 'lib/recurly/resources/add_on.rb', line 27

define_attribute :code, String

#created_at ⇒ DateTime

Returns Created at.

Returns:

• (DateTime) —

  Created at

# File 'lib/recurly/resources/add_on.rb', line 31

define_attribute :created_at, DateTime

#currencies ⇒ Array[AddOnPricing]

Returns Add-on pricing.

Returns:

• (Array[AddOnPricing]) —

  Add-on pricing

# File 'lib/recurly/resources/add_on.rb', line 35

define_attribute :currencies, Array, { :item_type => :AddOnPricing }

#default_quantity ⇒ Integer

Returns Default quantity for the hosted pages.

Returns:

• (Integer) —

  Default quantity for the hosted pages.

# File 'lib/recurly/resources/add_on.rb', line 39

define_attribute :default_quantity, Integer

#deleted_at ⇒ DateTime

Returns Deleted at.

Returns:

• (DateTime) —

  Deleted at

# File 'lib/recurly/resources/add_on.rb', line 43

define_attribute :deleted_at, DateTime

#display_quantity ⇒ Boolean

Returns Determines if the quantity field is displayed on the hosted pages for the add-on.

Returns:

• (Boolean) —

  Determines if the quantity field is displayed on the hosted pages for the add-on.

# File 'lib/recurly/resources/add_on.rb', line 47

define_attribute :display_quantity, :Boolean

#external_sku ⇒ String

Returns Optional, stock keeping unit to link the item to other inventory systems.

Returns:

• (String) —

  Optional, stock keeping unit to link the item to other inventory systems.

# File 'lib/recurly/resources/add_on.rb', line 51

define_attribute :external_sku, String

#harmonized_system_code ⇒ String

Returns The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.

Returns:

• (String) —

  The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.

# File 'lib/recurly/resources/add_on.rb', line 55

define_attribute :harmonized_system_code, String

#id ⇒ String

Returns Add-on ID.

Returns:

• (String) —

  Add-on ID

# File 'lib/recurly/resources/add_on.rb', line 59

define_attribute :id, String

#item ⇒ ItemMini

Returns Just the important parts.

Returns:

• (ItemMini) —

  Just the important parts.

# File 'lib/recurly/resources/add_on.rb', line 63

define_attribute :item, :ItemMini

#liability_gl_account_id ⇒ String

Returns The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

Returns:

• (String) —

  The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

# File 'lib/recurly/resources/add_on.rb', line 67

define_attribute :liability_gl_account_id, String

#measured_unit_id ⇒ String

Returns System-generated unique identifier for an measured unit associated with the add-on.

Returns:

• (String) —

  System-generated unique identifier for an measured unit associated with the add-on.

# File 'lib/recurly/resources/add_on.rb', line 71

define_attribute :measured_unit_id, String

#name ⇒ String

Returns Describes your add-on and will appear in subscribers' invoices.

Returns:

• (String) —

  Describes your add-on and will appear in subscribers' invoices.

# File 'lib/recurly/resources/add_on.rb', line 75

define_attribute :name, String

#object ⇒ String

Returns Object type.

Returns:

• (String) —

  Object type

# File 'lib/recurly/resources/add_on.rb', line 79

define_attribute :object, String

#optional ⇒ Boolean

Returns Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.

Returns:

• (Boolean) —

  Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.

# File 'lib/recurly/resources/add_on.rb', line 83

define_attribute :optional, :Boolean

#percentage_tiers ⇒ Array[PercentageTiersByCurrency]

Returns This feature is currently in development and requires approval and enablement, please contact support.

Returns:

• (Array[PercentageTiersByCurrency]) —

  This feature is currently in development and requires approval and enablement, please contact support.

# File 'lib/recurly/resources/add_on.rb', line 87

define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }

#performance_obligation_id ⇒ String

Returns The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

Returns:

• (String) —

  The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

# File 'lib/recurly/resources/add_on.rb', line 91

define_attribute :performance_obligation_id, String

#plan_id ⇒ String

Returns Plan ID.

Returns:

• (String) —

  Plan ID

# File 'lib/recurly/resources/add_on.rb', line 95

define_attribute :plan_id, String

#revenue_gl_account_id ⇒ String

Returns The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

Returns:

• (String) —

  The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

# File 'lib/recurly/resources/add_on.rb', line 99

define_attribute :revenue_gl_account_id, String

#revenue_schedule_type ⇒ String

Returns When this add-on is invoiced, the line item will use this revenue schedule. If item_code/item_id is part of the request then revenue_schedule_type must be absent in the request as the value will be set from the item.

Returns:

• (String) —

  When this add-on is invoiced, the line item will use this revenue schedule. If item_code/item_id is part of the request then revenue_schedule_type must be absent in the request as the value will be set from the item.

# File 'lib/recurly/resources/add_on.rb', line 103

define_attribute :revenue_schedule_type, String

#state ⇒ String

Returns Add-ons can be either active or inactive.

Returns:

• (String) —

  Add-ons can be either active or inactive.

# File 'lib/recurly/resources/add_on.rb', line 107

define_attribute :state, String

#tax_code ⇒ String

Returns Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of unknown, physical, or digital tax codes. If item_code/item_id is part of the request then tax_code must be absent.

Returns:

• (String) —

  Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of unknown, physical, or digital tax codes. If item_code/item_id is part of the request then tax_code must be absent.

# File 'lib/recurly/resources/add_on.rb', line 111

define_attribute :tax_code, String

#tier_type ⇒ String

Returns The pricing model for the add-on. For more information, click here. See our Guide for an overview of how to configure quantity-based pricing models.

Returns:

• (String) —

  The pricing model for the add-on. For more information, click here. See our Guide for an overview of how to configure quantity-based pricing models.

# File 'lib/recurly/resources/add_on.rb', line 115

define_attribute :tier_type, String

#tiers ⇒ Array[Tier]

Returns Tiers.

Returns:

• (Array[Tier]) —

  Tiers

# File 'lib/recurly/resources/add_on.rb', line 119

define_attribute :tiers, Array, { :item_type => :Tier }

#updated_at ⇒ DateTime

Returns Last updated at.

Returns:

• (DateTime) —

  Last updated at

# File 'lib/recurly/resources/add_on.rb', line 123

define_attribute :updated_at, DateTime

#usage_calculation_type ⇒ String

Returns The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.

Returns:

• (String) —

  The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.

# File 'lib/recurly/resources/add_on.rb', line 127

define_attribute :usage_calculation_type, String

#usage_percentage ⇒ Float

Returns The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.

Returns:

• (Float) —

  The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.

# File 'lib/recurly/resources/add_on.rb', line 131

define_attribute :usage_percentage, Float

#usage_timeframe ⇒ String

Returns The time at which usage totals are reset for billing purposes.

Returns:

• (String) —

  The time at which usage totals are reset for billing purposes.

# File 'lib/recurly/resources/add_on.rb', line 135

define_attribute :usage_timeframe, String

#usage_type ⇒ String

Returns Type of usage, returns usage type if add_on_type is usage.

Returns:

• (String) —

  Type of usage, returns usage type if add_on_type is usage.

# File 'lib/recurly/resources/add_on.rb', line 139

define_attribute :usage_type, String