Class: Recurly::Resources::AddOn

Inherits:
Recurly::Resource show all
Defined in:
lib/recurly/resources/add_on.rb

Instance Attribute Summary collapse

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_codeString

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.



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

define_attribute :accounting_code, String

#add_on_typeString

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

Returns:

  • (String)

    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_typeInteger

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.

Returns:



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

define_attribute :avalara_service_type, Integer

#avalara_transaction_typeInteger

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.

Returns:



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

define_attribute :avalara_transaction_type, Integer

#codeString

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

Returns:

  • (String)

    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_atDateTime

Returns Created at.

Returns:

  • (DateTime)

    Created at



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

define_attribute :created_at, DateTime

#currenciesArray[AddOnPricing]

Returns Add-on pricing.

Returns:



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

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

#default_quantityInteger

Returns Default quantity for the hosted pages.

Returns:

  • (Integer)

    Default quantity for the hosted pages.



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

define_attribute :default_quantity, Integer

#deleted_atDateTime

Returns Deleted at.

Returns:

  • (DateTime)

    Deleted at



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

define_attribute :deleted_at, DateTime

#display_quantityBoolean

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.



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

define_attribute :display_quantity, :Boolean

#external_skuString

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.



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

define_attribute :external_sku, String

#idString

Returns Add-on ID.

Returns:

  • (String)

    Add-on ID



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

define_attribute :id, String

#itemItemMini

Returns Just the important parts.

Returns:

  • (ItemMini)

    Just the important parts.



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

define_attribute :item, :ItemMini

#measured_unit_idString

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.



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

define_attribute :measured_unit_id, String

#nameString

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

Returns:

  • (String)

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



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

define_attribute :name, String

#objectString

Returns Object type.

Returns:

  • (String)

    Object type



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

define_attribute :object, String

#optionalBoolean

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.



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

define_attribute :optional, :Boolean

#plan_idString

Returns Plan ID.

Returns:

  • (String)

    Plan ID



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

define_attribute :plan_id, String

#revenue_schedule_typeString

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.



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

define_attribute :revenue_schedule_type, String

#stateString

Returns Add-ons can be either active or inactive.

Returns:

  • (String)

    Add-ons can be either active or inactive.



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

define_attribute :state, String

#tax_codeString

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`.

Returns:

  • (String)

    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`.



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

define_attribute :tax_code, String

#tier_typeString

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](developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.

Returns:



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

define_attribute :tier_type, String

#tiersArray[Tier]

Returns Tiers.

Returns:

  • (Array[Tier])

    Tiers



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

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

#updated_atDateTime

Returns Last updated at.

Returns:

  • (DateTime)

    Last updated at



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

define_attribute :updated_at, DateTime

#usage_percentageFloat

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.



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

define_attribute :usage_percentage, Float

#usage_typeString

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`.



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

define_attribute :usage_type, String