StripeAPI.Types.UsageRecord

Contains the types generated from the schema UsageRecord

Documentation

data UsageRecord

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

UsageRecord

Fields

• usageRecordId :: Text

  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 :: Text

  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

Defined in StripeAPI.Types.UsageRecord

Methods

(==) :: UsageRecord -> UsageRecord -> Bool

(/=) :: UsageRecord -> UsageRecord -> Bool

Show UsageRecord

Defined in StripeAPI.Types.UsageRecord

Methods

showsPrec :: Int -> UsageRecord -> ShowS

show :: UsageRecord -> String

showList :: [UsageRecord] -> ShowS

ToJSON UsageRecord

Defined in StripeAPI.Types.UsageRecord

Methods

toJSON :: UsageRecord -> Value

toEncoding :: UsageRecord -> Encoding

toJSONList :: [UsageRecord] -> Value

toEncodingList :: [UsageRecord] -> Encoding

FromJSON UsageRecord

Defined in StripeAPI.Types.UsageRecord

Methods

parseJSON :: Value -> Parser UsageRecord

parseJSONList :: Value -> Parser [UsageRecord]

data UsageRecordObject'

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 Text

UsageRecordObject'EnumStringUsageRecord

Instances

Eq UsageRecordObject'

Defined in StripeAPI.Types.UsageRecord

Methods

(==) :: UsageRecordObject' -> UsageRecordObject' -> Bool

(/=) :: UsageRecordObject' -> UsageRecordObject' -> Bool

Show UsageRecordObject'

Defined in StripeAPI.Types.UsageRecord

Methods

showsPrec :: Int -> UsageRecordObject' -> ShowS

show :: UsageRecordObject' -> String

showList :: [UsageRecordObject'] -> ShowS

ToJSON UsageRecordObject'

Defined in StripeAPI.Types.UsageRecord

Methods

toJSON :: UsageRecordObject' -> Value

toEncoding :: UsageRecordObject' -> Encoding

toJSONList :: [UsageRecordObject'] -> Value

toEncodingList :: [UsageRecordObject'] -> Encoding

FromJSON UsageRecordObject'

Defined in StripeAPI.Types.UsageRecord

Methods

parseJSON :: Value -> Parser UsageRecordObject'

parseJSONList :: Value -> Parser [UsageRecordObject']