class Stripe::Price

• Stripe::Price
• Reference
• Object

Overview

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. Related guides: Set up a subscription, create an invoice, and more about products and prices.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [one_time, recurring]."

ERROR_MESSAGE_FOR_BILLING_SCHEME = "invalid value for \"billing_scheme\", must be one of [per_unit, tiered]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [price]."

ERROR_MESSAGE_FOR_TAX_BEHAVIOR = "invalid value for \"tax_behavior\", must be one of [exclusive, inclusive, unspecified]."

ERROR_MESSAGE_FOR_TIERS_MODE = "invalid value for \"tiers_mode\", must be one of [graduated, volume]."

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_LOOKUP_KEY = 5000

MAX_LENGTH_FOR_NICKNAME = 5000

VALID_VALUES_FOR__TYPE = String.static_array("one_time", "recurring")

VALID_VALUES_FOR_BILLING_SCHEME = String.static_array("per_unit", "tiered")

VALID_VALUES_FOR_OBJECT = String.static_array("price")

VALID_VALUES_FOR_TAX_BEHAVIOR = String.static_array("exclusive", "inclusive", "unspecified")

VALID_VALUES_FOR_TIERS_MODE = String.static_array("graduated", "volume")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, active : Bool | Nil = nil, billing_scheme : String | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, custom_unit_amount : Stripe::CurrencyOptionCustomUnitAmount | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, lookup_key : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, nickname : String | Nil = nil, object : String | Nil = nil, product : Stripe::PriceProduct | Nil = nil, recurring : Stripe::PriceRecurring | Nil = nil, tax_behavior : String | Nil = nil, tiers_mode : String | Nil = nil, transform_quantity : Stripe::PriceTransformQuantity | Nil = nil, _type : String | Nil = nil, unit_amount : Int64 | Nil = nil, unit_amount_decimal : BigDecimal | Nil = nil, currency_options : Hash(String, Stripe::CurrencyOption) | Nil = nil, tiers : Array(Stripe::PriceTier) | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance Method Summary

• #==(other : self)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #_type : String | Nil
• #_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #active : Bool | Nil
• #active=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #billing_scheme : String | Nil
• #billing_scheme=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency_options : Hash(String, Stripe::CurrencyOption) | Nil
• #currency_options=(new_value : Hash(String, Stripe::CurrencyOption) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #custom_unit_amount : Stripe::CurrencyOptionCustomUnitAmount | Nil
• #custom_unit_amount=(new_value : Stripe::CurrencyOptionCustomUnitAmount | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #lookup_key : String | Nil
• #lookup_key=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #nickname : String | Nil
• #nickname=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #product : Stripe::PriceProduct | Nil
• #product=(new_value : Stripe::PriceProduct | Nil)

  Custom attribute writer method checking allowed values (enum).

• #recurring : Stripe::PriceRecurring | Nil
• #recurring=(new_value : Stripe::PriceRecurring | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tax_behavior : String | Nil
• #tax_behavior=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tiers : Array(Stripe::PriceTier) | Nil
• #tiers=(new_value : Array(Stripe::PriceTier) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tiers_mode : String | Nil
• #tiers_mode=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transform_quantity : Stripe::PriceTransformQuantity | Nil
• #transform_quantity=(new_value : Stripe::PriceTransformQuantity | Nil)

  Custom attribute writer method checking allowed values (enum).

• #unit_amount : Int64 | Nil
• #unit_amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #unit_amount_decimal : BigDecimal | Nil
• #unit_amount_decimal=(new_value : BigDecimal | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

  Check to see if the all the properties in the model are valid @return true if the model is valid

Constructor Detail

Instance Method Detail