Class: Recurly::Resources::AddOn
- Inherits:
-
Recurly::Resource
- Object
- Recurly::Resource
- Recurly::Resources::AddOn
- Defined in:
- lib/recurly/resources/add_on.rb
Instance Attribute Summary collapse
-
#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.
-
#id ⇒ String
Add-on ID.
-
#item ⇒ ItemMini
Just the important parts.
-
#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.
-
#plan_id ⇒ String
Plan ID.
-
#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
Used by Avalara, Vertex, and Recurly’s EU VAT tax feature.
-
#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
Method Summary
Methods inherited from Recurly::Resource
#==, #get_response, #inspect, #requires_client?, #to_json, #to_s
Methods included from Schema::SchemaFactory
Methods included from Schema::ResourceCaster
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.
11 |
# 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.
15 |
# 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](help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
19 |
# 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](help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
23 |
# 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.
27 |
# File 'lib/recurly/resources/add_on.rb', line 27 define_attribute :code, String |
#created_at ⇒ DateTime
Returns Created at.
31 |
# File 'lib/recurly/resources/add_on.rb', line 31 define_attribute :created_at, DateTime |
#currencies ⇒ Array[AddOnPricing]
Returns Add-on pricing.
35 |
# 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.
39 |
# File 'lib/recurly/resources/add_on.rb', line 39 define_attribute :default_quantity, Integer |
#deleted_at ⇒ DateTime
Returns Deleted at.
43 |
# 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.
47 |
# 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.
51 |
# File 'lib/recurly/resources/add_on.rb', line 51 define_attribute :external_sku, String |
#id ⇒ String
Returns Add-on ID.
55 |
# File 'lib/recurly/resources/add_on.rb', line 55 define_attribute :id, String |
#item ⇒ ItemMini
Returns Just the important parts.
59 |
# File 'lib/recurly/resources/add_on.rb', line 59 define_attribute :item, :ItemMini |
#measured_unit_id ⇒ String
Returns System-generated unique identifier for an measured unit associated with the add-on.
63 |
# File 'lib/recurly/resources/add_on.rb', line 63 define_attribute :measured_unit_id, String |
#name ⇒ String
Returns Describes your add-on and will appear in subscribers' invoices.
67 |
# File 'lib/recurly/resources/add_on.rb', line 67 define_attribute :name, String |
#object ⇒ String
Returns Object type.
71 |
# File 'lib/recurly/resources/add_on.rb', line 71 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.
75 |
# File 'lib/recurly/resources/add_on.rb', line 75 define_attribute :optional, :Boolean |
#percentage_tiers ⇒ Array[PercentageTiersByCurrency]
Returns This feature is currently in development and requires approval and enablement, please contact support.
79 |
# File 'lib/recurly/resources/add_on.rb', line 79 define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency } |
#plan_id ⇒ String
Returns Plan ID.
83 |
# File 'lib/recurly/resources/add_on.rb', line 83 define_attribute :plan_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.
87 |
# File 'lib/recurly/resources/add_on.rb', line 87 define_attribute :revenue_schedule_type, String |
#state ⇒ String
Returns Add-ons can be either active or inactive.
91 |
# File 'lib/recurly/resources/add_on.rb', line 91 define_attribute :state, String |
#tax_code ⇒ String
Returns Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
95 |
# File 'lib/recurly/resources/add_on.rb', line 95 define_attribute :tax_code, String |
#tier_type ⇒ String
Returns The pricing model for the add-on. For more information, [click here](docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
99 |
# File 'lib/recurly/resources/add_on.rb', line 99 define_attribute :tier_type, String |
#tiers ⇒ Array[Tier]
Returns Tiers.
103 |
# File 'lib/recurly/resources/add_on.rb', line 103 define_attribute :tiers, Array, { :item_type => :Tier } |
#updated_at ⇒ DateTime
Returns Last updated at.
107 |
# File 'lib/recurly/resources/add_on.rb', line 107 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.
111 |
# File 'lib/recurly/resources/add_on.rb', line 111 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.
115 |
# File 'lib/recurly/resources/add_on.rb', line 115 define_attribute :usage_percentage, Float |
#usage_timeframe ⇒ String
Returns The time at which usage totals are reset for billing purposes.
119 |
# File 'lib/recurly/resources/add_on.rb', line 119 define_attribute :usage_timeframe, String |
#usage_type ⇒ String
Returns Type of usage, returns usage type if `add_on_type` is `usage`.
123 |
# File 'lib/recurly/resources/add_on.rb', line 123 define_attribute :usage_type, String |