Class: Recurly::Resources::AddOnMini

Inherits:
Recurly::Resource show all
Defined in:
lib/recurly/resources/add_on_mini.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_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.



11
 
# File 'lib/recurly/resources/add_on_mini.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.



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

define_attribute :add_on_type, String

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



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

define_attribute :code, String

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



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

define_attribute :external_sku, String

#id ⇒ String

Returns Add-on ID.

Returns:

  • (String) —

    Add-on ID



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

define_attribute :id, String

#item_id ⇒ String

Returns Item ID.

Returns:

  • (String) —

    Item ID



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

define_attribute :item_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.



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

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.



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

define_attribute :name, String

#object ⇒ String

Returns Object type.

Returns:

  • (String) —

    Object type



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

define_attribute :object, 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.



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

define_attribute :usage_percentage, Float

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



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

define_attribute :usage_type, String