class Stripe::UsageRecord

Overview

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.

Included Modules

Defined in:

stripe/models/usage_record.cr

Constant Summary

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def quantity : Int64 | Nil #

[View source]
def quantity=(new_value : Int64 | Nil) #

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


[View source]
def subscription_item : String | Nil #

[View source]
def subscription_item=(new_value : String | Nil) #

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


[View source]
def timestamp : Int64 | Nil #

[View source]
def timestamp=(new_value : Int64 | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]