Class: Recurly::Resources::PlanPricing

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::PlanPricing

Defined in:

lib/recurly/resources/plan_pricing.rb

Instance Attribute Summary

• #currency ⇒ String

  3-letter ISO 4217 currency code.

• #price_segment_id ⇒ String

  The price segment ID or code.

• #setup_fee ⇒ Float

  This field is deprecated, please use top level `setup_fees` instead.

• #tax_inclusive ⇒ Boolean

  This field is deprecated.

• #unit_amount ⇒ Float

  This field should not be sent when the pricing model is `'ramp'`.

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

#currency ⇒ String

Returns 3-letter ISO 4217 currency code.

Returns:

• (String) —

  3-letter ISO 4217 currency code.

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

define_attribute :currency, String

#price_segment_id ⇒ String

Returns The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.

Returns:

• (String) —

  The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.

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

define_attribute :price_segment_id, String

#setup_fee ⇒ Float

Returns This field is deprecated, please use top level `setup_fees` instead. Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.

Returns:

• (Float) —

  This field is deprecated, please use top level `setup_fees` instead. Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.

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

define_attribute :setup_fee, Float

#tax_inclusive ⇒ Boolean

Returns This field is deprecated. Please do not use it.

Returns:

• (Boolean) —

  This field is deprecated. Please do not use it.

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

define_attribute :tax_inclusive, :Boolean

#unit_amount ⇒ Float

Returns This field should not be sent when the pricing model is `'ramp'`.

Returns:

• (Float) —

  This field should not be sent when the pricing model is `'ramp'`.

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

define_attribute :unit_amount, Float