class

Stripe::UsageRecord

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

Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription prices. Related guide: Metered billing This is our legacy usage-based billing API. See the updated usage-based billing docs.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [usage_record]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_SUBSCRIPTION_ITEM = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("usage_record")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, quantity : Int64 | Nil = nil, subscription_item : String | Nil = nil, timestamp : Int64 | 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

hash(hasher)

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

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id 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
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

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

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

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

Source
quantity

The usage quantity for the specified date.

Source
quantity=(new_value : Int64 | Nil)

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

Source
subscription_item

The ID of the subscription item this usage record contains data for.

Source
subscription_item=(new_value : String | Nil)

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

Source
timestamp

The timestamp when this usage occurred.

Source
timestamp=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] timestamp 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