Class: Recurly::Requests::SubscriptionAddOnUpdate

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::SubscriptionAddOnUpdate

Defined in:

lib/recurly/requests/subscription_add_on_update.rb

Instance Attribute Summary

• #add_on_source ⇒ String

  Used to determine where the associated add-on data is pulled from.

• #code ⇒ String

  If a code is provided without an id, the subscription add-on attributes will be set to the current value for those attributes on the plan add-on unless provided in the request.

• #id ⇒ String

  When an id is provided, the existing subscription add-on attributes will persist unless overridden in the request.

• #percentage_tiers ⇒ Array[SubscriptionAddOnPercentageTier]

  If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request.

• #quantity ⇒ Integer

  Quantity.

• #revenue_schedule_type ⇒ String

  Revenue schedule type.

• #tiers ⇒ Array[SubscriptionAddOnTier]

  If the plan add-on’s ‘tier_type` is `flat`, then `tiers` must be absent.

• #unit_amount ⇒ Float

  Allows up to 2 decimal places.

• #unit_amount_decimal ⇒ String

  Allows up to 9 decimal places.

• #usage_percentage ⇒ Float

  The percentage taken of the monetary amount of usage tracked.

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

#add_on_source ⇒ String

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

define_attribute :add_on_source, String

#code ⇒ String

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

define_attribute :code, String

#id ⇒ String

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

define_attribute :id, String

#percentage_tiers ⇒ Array[SubscriptionAddOnPercentageTier]

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

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

#quantity ⇒ Integer

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

define_attribute :quantity, Integer

#revenue_schedule_type ⇒ String

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

define_attribute :revenue_schedule_type, String

#tiers ⇒ Array[SubscriptionAddOnTier]

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

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

#unit_amount ⇒ Float

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

define_attribute :unit_amount, Float

#unit_amount_decimal ⇒ String

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

define_attribute :unit_amount_decimal, String

#usage_percentage ⇒ Float

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

define_attribute :usage_percentage, Float