Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.UsageRecord

Description

Contains the types generated from the schema UsageRecord

Documentation

Defines the data type for the schema usage_record

Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription plans.

Related guide: Metered Billing.

Constructors

Fields

usageRecordId :: String
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
usageRecordLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
usageRecordObject :: UsageRecordObject'
object: String representing the object's type. Objects of the same type share the same value.
usageRecordQuantity :: Integer
quantity: The usage quantity for the specified date.
usageRecordSubscriptionItem :: String
subscription_item: The ID of the subscription item this usage record contains data for.
Constraints:
- Maximum length of 5000
usageRecordTimestamp :: Integer
timestamp: The timestamp when this usage occurred.

Instances

Eq UsageRecord Source #
Instance details Defined in StripeAPI.Types.UsageRecord Methods (==) :: UsageRecord -> UsageRecord -> Bool # (/=) :: UsageRecord -> UsageRecord -> Bool #
Show UsageRecord Source #
Instance details Defined in StripeAPI.Types.UsageRecord Methods showsPrec :: Int -> UsageRecord -> ShowS # show :: UsageRecord -> String # showList :: [UsageRecord] -> ShowS #
ToJSON UsageRecord Source #
Instance details Defined in StripeAPI.Types.UsageRecord Methods toJSON :: UsageRecord -> Value # toEncoding :: UsageRecord -> Encoding # toJSONList :: [UsageRecord] -> Value # toEncodingList :: [UsageRecord] -> Encoding #
FromJSON UsageRecord Source #
Instance details Defined in StripeAPI.Types.UsageRecord Methods parseJSON :: Value -> Parser UsageRecord # parseJSONList :: Value -> Parser [UsageRecord] #

Defines the enum schema usage_recordObject'

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

Constructors

UsageRecordObject'EnumOther Value
UsageRecordObject'EnumTyped String
UsageRecordObject'EnumStringUsageRecord

Instances

Eq UsageRecordObject' Source #
Instance details Defined in StripeAPI.Types.UsageRecord Methods (==) :: UsageRecordObject' -> UsageRecordObject' -> Bool # (/=) :: UsageRecordObject' -> UsageRecordObject' -> Bool #
Show UsageRecordObject' Source #
Instance details Defined in StripeAPI.Types.UsageRecord Methods showsPrec :: Int -> UsageRecordObject' -> ShowS # show :: UsageRecordObject' -> String # showList :: [UsageRecordObject'] -> ShowS #
ToJSON UsageRecordObject' Source #
Instance details Defined in StripeAPI.Types.UsageRecord Methods toJSON :: UsageRecordObject' -> Value # toEncoding :: UsageRecordObject' -> Encoding # toJSONList :: [UsageRecordObject'] -> Value # toEncodingList :: [UsageRecordObject'] -> Encoding #
FromJSON UsageRecordObject' Source #
Instance details Defined in StripeAPI.Types.UsageRecord Methods parseJSON :: Value -> Parser UsageRecordObject' # parseJSONList :: Value -> Parser [UsageRecordObject'] #