Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.Usage

Description

Contains the types generated from the schema Usage

Synopsis

data Usage = Usage {
- usageAmount :: Maybe Float
- usageBilled_at :: Maybe JsonDateTime
- usageCreated_at :: Maybe JsonDateTime
- usageId :: Maybe Text
- usageMeasured_unit_id :: Maybe Text
- usageMerchant_tag :: Maybe Text
- usageObject :: Maybe Text
- usagePercentage_tiers :: Maybe [SubscriptionAddOnPercentageTier]
- usageRecording_timestamp :: Maybe JsonDateTime
- usageTier_type :: Maybe UsageTier_type
- usageTiers :: Maybe [SubscriptionAddOnTier]
- usageUnit_amount :: Maybe Float
- usageUnit_amount_decimal :: Maybe Text
- usageUpdated_at :: Maybe JsonDateTime
- usageUsage_percentage :: Maybe Float
- usageUsage_timestamp :: Maybe JsonDateTime
- usageUsage_type :: Maybe UsageUsage_type
}
mkUsage :: Usage
data UsageTier_type
data UsageUsage_type

Documentation

data Usage Source #

Defines the object schema located at components.schemas.Usage in the specification.

Constructors

Usage

Fields

usageAmount :: Maybe Float
amount: The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
usageBilled_at :: Maybe JsonDateTime
billed_at: When the usage record was billed on an invoice.
usageCreated_at :: Maybe JsonDateTime
created_at: When the usage record was created in Recurly.
usageId :: Maybe Text
id
usageMeasured_unit_id :: Maybe Text
measured_unit_id: The ID of the measured unit associated with the add-on the usage record is for.
usageMerchant_tag :: Maybe Text
merchant_tag: Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
usageObject :: Maybe Text
object
usagePercentage_tiers :: Maybe [SubscriptionAddOnPercentageTier]
percentage_tiers: The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []. This feature is currently in development and requires approval and enablement, please contact support.
usageRecording_timestamp :: Maybe JsonDateTime
recording_timestamp: When the usage was recorded in your system.
usageTier_type :: Maybe UsageTier_type
tier_type: The pricing model for the add-on. For more information, click here. See our Guide for an overview of how to configure quantity-based pricing models.
usageTiers :: Maybe [SubscriptionAddOnTier]
tiers: The tiers and prices of the subscription based on the usage_timestamp. If tier_type = flat, tiers = []
usageUnit_amount :: Maybe Float
unit_amount
usageUnit_amount_decimal :: Maybe Text
unit_amount_decimal: Unit price that can optionally support a sub-cent value.
Constraints:
- Maxium of 1000000.0
- Minimum of 0.0
usageUpdated_at :: Maybe JsonDateTime
updated_at: When the usage record was billed on an invoice.
usageUsage_percentage :: Maybe Float
usage_percentage: The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.
usageUsage_timestamp :: Maybe JsonDateTime
usage_timestamp: When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
usageUsage_type :: Maybe UsageUsage_type
usage_type: Type of usage, returns usage type if `add_on_type` is `usage`.

Instances

Instances details

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

mkUsage :: Usage Source #

Create a new Usage with all required fields.

data UsageTier_type Source #

Defines the enum schema located at components.schemas.Usage.properties.tier_type in the specification.

The pricing model for the add-on. For more information, click here. See our Guide for an overview of how to configure quantity-based pricing models.

Constructors

UsageTier_typeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
UsageTier_typeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
UsageTier_typeEnumFlat	Represents the JSON value `"flat"`
UsageTier_typeEnumTiered	Represents the JSON value `"tiered"`
UsageTier_typeEnumStairstep	Represents the JSON value `"stairstep"`
UsageTier_typeEnumVolume	Represents the JSON value `"volume"`

Instances

Instances details

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

data UsageUsage_type Source #

Defines the enum schema located at components.schemas.Usage.properties.usage_type in the specification.

Type of usage, returns usage type if `add_on_type` is `usage`.

Constructors

UsageUsage_typeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
UsageUsage_typeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
UsageUsage_typeEnumPrice	Represents the JSON value `"price"`
UsageUsage_typeEnumPercentage	Represents the JSON value `"percentage"`

Instances

Instances details

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