class Stripe::SubscriptionScheduleConfigurationItemPlan

• Stripe::SubscriptionScheduleConfigurationItemPlan
• Reference
• Object

Overview

ID of the plan to which the customer should be subscribed.

Included Modules

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

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_AGGREGATE_USAGE = "invalid value for \"aggregate_usage\", must be one of [last_during_period, last_ever, max, sum]."

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

ERROR_MESSAGE_FOR_INTERVAL = "invalid value for \"interval\", must be one of [day, month, week, year]."

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

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

ERROR_MESSAGE_FOR_USAGE_TYPE = "invalid value for \"usage_type\", must be one of [licensed, metered]."

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_METER = 5000

MAX_LENGTH_FOR_NICKNAME = 5000

VALID_VALUES_FOR_AGGREGATE_USAGE = String.static_array("last_during_period", "last_ever", "max", "sum")

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

VALID_VALUES_FOR_INTERVAL = String.static_array("day", "month", "week", "year")

VALID_VALUES_FOR_OBJECT = String.static_array("plan")

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

VALID_VALUES_FOR_USAGE_TYPE = String.static_array("licensed", "metered")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, deleted : Bool | Nil = nil, id : String | Nil = nil, object : String | Nil = nil, active : Bool | Nil = nil, aggregate_usage : String | Nil = nil, amount : Int64 | Nil = nil, amount_decimal : BigDecimal | Nil = nil, billing_scheme : String | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, interval : String | Nil = nil, interval_count : Int64 | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, meter : String | Nil = nil, nickname : String | Nil = nil, product : Stripe::PlanProduct | Nil = nil, tiers_mode : String | Nil = nil, transform_usage : Stripe::TransformUsage | Nil = nil, trial_period_days : Int64 | Nil = nil, usage_type : String | Nil = nil, tiers : Array(Stripe::PlanTier) | Nil = nil)

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

Class Method Summary

• .openapi_any_of

  List of class defined in anyOf (OpenAPI v3)

Instance Method Summary

• #==(other : self)

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

• #active : Bool | Nil
• #active=(active : Bool | Nil)
• #aggregate_usage : String | Nil
• #aggregate_usage=(aggregate_usage : String | Nil)
• #amount : Int64 | Nil
• #amount=(amount : Int64 | Nil)
• #amount_decimal : BigDecimal | Nil
• #amount_decimal=(amount_decimal : BigDecimal | Nil)
• #billing_scheme : String | Nil
• #billing_scheme=(billing_scheme : String | Nil)
• #created : Int64 | Nil
• #created=(created : Int64 | Nil)
• #currency : String | Nil
• #currency=(currency : String | Nil)
• #deleted : Bool | Nil
• #deleted=(deleted : Bool | Nil)
• #hash(hasher)

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

• #id : String | Nil
• #id=(id : String | Nil)
• #interval : String | Nil
• #interval=(interval : String | Nil)
• #interval_count : Int64 | Nil
• #interval_count=(interval_count : Int64 | Nil)
• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(livemode : Bool | Nil)
• #metadata : Hash(String, String) | Nil
• #metadata=(metadata : Hash(String, String) | Nil)
• #meter : String | Nil
• #meter=(meter : String | Nil)
• #nickname : String | Nil
• #nickname=(nickname : String | Nil)
• #object : String | Nil
• #object=(object : String | Nil)
• #product : Stripe::PlanProduct | Nil
• #product=(product : Stripe::PlanProduct | Nil)
• #tiers : Array(Stripe::PlanTier) | Nil
• #tiers=(tiers : Array(Stripe::PlanTier) | Nil)
• #tiers_mode : String | Nil
• #tiers_mode=(tiers_mode : String | Nil)
• #transform_usage : Stripe::TransformUsage | Nil
• #transform_usage=(transform_usage : Stripe::TransformUsage | Nil)
• #trial_period_days : Int64 | Nil
• #trial_period_days=(trial_period_days : Int64 | Nil)
• #usage_type : String | Nil
• #usage_type=(usage_type : String | Nil)
• #valid? : Bool

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

Constructor Detail

Class Method Detail

Instance Method Detail