class

Stripe::Recurring

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Constants

ERROR_MESSAGE_FOR_AGGREGATE_USAGE = "invalid value for \"aggregate_usage\", must be one of [last_during_period, last_ever, max, sum]."
ERROR_MESSAGE_FOR_INTERVAL = "invalid value for \"interval\", must be one of [day, month, week, year]."
ERROR_MESSAGE_FOR_USAGE_TYPE = "invalid value for \"usage_type\", must be one of [licensed, metered]."
MAX_LENGTH_FOR_METER = 5000
VALID_VALUES_FOR_AGGREGATE_USAGE = String.static_array("last_during_period", "last_ever", "max", "sum")
VALID_VALUES_FOR_INTERVAL = String.static_array("day", "month", "week", "year")
VALID_VALUES_FOR_USAGE_TYPE = String.static_array("licensed", "metered")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, aggregate_usage : String | Nil = nil, interval : String | Nil = nil, interval_count : Int64 | Nil = nil, meter : String | Nil = nil, trial_period_days : Int64 | Nil = nil, usage_type : String | Nil = nil)

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

Source

Instance methods

==(other : self)

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

aggregate_usage

Specifies a usage aggregation strategy for prices of usage_type=metered. Defaults to sum.

Source
aggregate_usage=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] aggregate_usage Object to be assigned

Source
hash(hasher)

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

interval

The frequency at which a subscription is billed. One of day, week, month or year.

Source
interval=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] interval Object to be assigned

Source
interval_count

The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.

Source
interval_count=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] interval_count Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
meter

The meter tracking the usage of a metered price

Source
meter=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] meter Object to be assigned

Source
trial_period_days

Default number of trial days when subscribing a customer to this price using trial_from_plan=true.

Source
trial_period_days=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] trial_period_days Object to be assigned

Source
usage_type

Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

Source
usage_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] usage_type Object to be assigned

Source
valid?

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

Source