Class: Recurly::Requests::AddOnCreate

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::AddOnCreate

Defined in:

lib/recurly/requests/add_on_create.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.

• #currencies ⇒ Array[AddOnPricing]

  • If ‘item_code`/`item_id` is part of the request and the item has a default currency, then `currencies` is optional.

• #default_quantity ⇒ Integer

  Default quantity for the hosted pages.

• #display_quantity ⇒ Boolean

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

• #item_code ⇒ String

  Unique code to identify an item.

• #item_id ⇒ String

  System-generated unique identifier for an item.

• #liability_gl_account_id ⇒ String

  The ID of a general ledger account.

• #measured_unit_id ⇒ String

  System-generated unique identifier for a measured unit to be associated with the add-on.

• #measured_unit_name ⇒ String

  Name of a measured unit to be associated with the add-on.

• #name ⇒ String

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

• #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]

  Array of objects which must have at least one set of tiers per currency and the currency code.

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

• #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]

  If the tier_type is ‘flat`, then `tiers` must be absent.

• #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, required if ‘add_on_type` is `usage`.

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#accounting_code ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 11

define_attribute :accounting_code, String

#add_on_type ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 15

define_attribute :add_on_type, String

#avalara_service_type ⇒ Integer

# File 'lib/recurly/requests/add_on_create.rb', line 19

define_attribute :avalara_service_type, Integer

#avalara_transaction_type ⇒ Integer

# File 'lib/recurly/requests/add_on_create.rb', line 23

define_attribute :avalara_transaction_type, Integer

#code ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 27

define_attribute :code, String

#currencies ⇒ Array[AddOnPricing]

# File 'lib/recurly/requests/add_on_create.rb', line 31

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

#default_quantity ⇒ Integer

# File 'lib/recurly/requests/add_on_create.rb', line 35

define_attribute :default_quantity, Integer

#display_quantity ⇒ Boolean

# File 'lib/recurly/requests/add_on_create.rb', line 39

define_attribute :display_quantity, :Boolean

#item_code ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 43

define_attribute :item_code, String

#item_id ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 47

define_attribute :item_id, String

#liability_gl_account_id ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 51

define_attribute :liability_gl_account_id, String

#measured_unit_id ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 55

define_attribute :measured_unit_id, String

#measured_unit_name ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 59

define_attribute :measured_unit_name, String

#name ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 63

define_attribute :name, String

#optional ⇒ Boolean

# File 'lib/recurly/requests/add_on_create.rb', line 67

define_attribute :optional, :Boolean

#percentage_tiers ⇒ Array[PercentageTiersByCurrency]

# File 'lib/recurly/requests/add_on_create.rb', line 71

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

#performance_obligation_id ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 75

define_attribute :performance_obligation_id, String

#plan_id ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 79

define_attribute :plan_id, String

#revenue_gl_account_id ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 83

define_attribute :revenue_gl_account_id, String

#revenue_schedule_type ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 87

define_attribute :revenue_schedule_type, String

#tax_code ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 91

define_attribute :tax_code, String

#tier_type ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 95

define_attribute :tier_type, String

#tiers ⇒ Array[Tier]

# File 'lib/recurly/requests/add_on_create.rb', line 99

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

#usage_calculation_type ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 103

define_attribute :usage_calculation_type, String

#usage_percentage ⇒ Float

# File 'lib/recurly/requests/add_on_create.rb', line 107

define_attribute :usage_percentage, Float

#usage_timeframe ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 111

define_attribute :usage_timeframe, String

#usage_type ⇒ String

# File 'lib/recurly/requests/add_on_create.rb', line 115

define_attribute :usage_type, String