Class: Recurly::Requests::SubscriptionAddOnTier

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::SubscriptionAddOnTier

Defined in:

lib/recurly/requests/subscription_add_on_tier.rb

Instance Attribute Summary

• #ending_quantity ⇒ Integer

  Ending quantity for the tier.

• #unit_amount ⇒ Float

  Allows up to 2 decimal places.

• #unit_amount_decimal ⇒ String

  Allows up to 9 decimal places.

• #usage_percentage ⇒ String

  (deprecated) – Use the percentage_tiers object instead.

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

#ending_quantity ⇒ Integer

Returns Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.

Returns:

• (Integer) —

  Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.

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

define_attribute :ending_quantity, Integer

#unit_amount ⇒ Float

Returns Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.

Returns:

• (Float) —

  Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.

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

define_attribute :unit_amount, Float

#unit_amount_decimal ⇒ String

Returns Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.

Returns:

• (String) —

  Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.

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

define_attribute :unit_amount_decimal, String

#usage_percentage ⇒ String

Returns (deprecated) – Use the percentage_tiers object instead.

Returns:

• (String) —

  (deprecated) – Use the percentage_tiers object instead.

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

define_attribute :usage_percentage, String