Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.AddOnMini

Description

Contains the types generated from the schema AddOnMini

Documentation

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

Just the important parts.

Constructors

Fields

addOnMiniAccounting_code :: Maybe Text
accounting_code: Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code.
Constraints:
- Maximum length of 20
- Must match pattern '/^[a-z0-9_+-]+$/'
addOnMiniAdd_on_type :: Maybe AddOnMiniAdd_on_type
add_on_type: Whether the add-on type is fixed, or usage-based.
addOnMiniCode :: Maybe Text
code: The unique identifier for the add-on within its plan.
Constraints:
- Maximum length of 50
addOnMiniExternal_sku :: Maybe Text
external_sku: Optional, stock keeping unit to link the item to other inventory systems.
Constraints:
- Maximum length of 50
addOnMiniId :: Maybe Text
id
Constraints:
- Maximum length of 13
addOnMiniItem_id :: Maybe Text
item_id
Constraints:
- Maximum length of 13
addOnMiniMeasured_unit_id :: Maybe Text
measured_unit_id: System-generated unique identifier for an measured unit associated with the add-on.
Constraints:
- Maximum length of 13
addOnMiniName :: Maybe Text
name: Describes your add-on and will appear in subscribers' invoices.
Constraints:
- Maximum length of 255
addOnMiniObject :: Maybe Text
object
addOnMiniUsage_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.
addOnMiniUsage_type :: Maybe AddOnMiniUsage_type
usage_type: Type of usage, returns usage type if `add_on_type` is `usage`.

Instances details

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

Create a new AddOnMini with all required fields.

Defines the enum schema located at components.schemas.AddOnMini.properties.add_on_type in the specification.

Whether the add-on type is fixed, or usage-based.

Constructors

AddOnMiniAdd_on_typeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
AddOnMiniAdd_on_typeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
AddOnMiniAdd_on_typeEnumFixed	Represents the JSON value `"fixed"`
AddOnMiniAdd_on_typeEnumUsage	Represents the JSON value `"usage"`

Instances details

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

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

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

Constructors

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

Instances details

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