| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Types.SubscriptionAddOn
Description
Contains the types generated from the schema SubscriptionAddOn
Synopsis
- data SubscriptionAddOn = SubscriptionAddOn {
- subscriptionAddOnAdd_on :: Maybe AddOnMini
- subscriptionAddOnAdd_on_source :: Maybe SubscriptionAddOnAdd_on_source
- subscriptionAddOnCreated_at :: Maybe JsonDateTime
- subscriptionAddOnExpired_at :: Maybe JsonDateTime
- subscriptionAddOnId :: Maybe Text
- subscriptionAddOnObject :: Maybe Text
- subscriptionAddOnPercentage_tiers :: Maybe (NonEmpty SubscriptionAddOnPercentageTier)
- subscriptionAddOnQuantity :: Maybe Int
- subscriptionAddOnRevenue_schedule_type :: Maybe SubscriptionAddOnRevenue_schedule_type
- subscriptionAddOnSubscription_id :: Maybe Text
- subscriptionAddOnTier_type :: Maybe SubscriptionAddOnTier_type
- subscriptionAddOnTiers :: Maybe (NonEmpty SubscriptionAddOnTier)
- subscriptionAddOnUnit_amount :: Maybe Float
- subscriptionAddOnUnit_amount_decimal :: Maybe Text
- subscriptionAddOnUpdated_at :: Maybe JsonDateTime
- subscriptionAddOnUsage_calculation_type :: Maybe SubscriptionAddOnUsage_calculation_type
- subscriptionAddOnUsage_percentage :: Maybe Float
- subscriptionAddOnUsage_timeframe :: Maybe SubscriptionAddOnUsage_timeframe
- mkSubscriptionAddOn :: SubscriptionAddOn
- data SubscriptionAddOnAdd_on_source
- data SubscriptionAddOnRevenue_schedule_type
- = SubscriptionAddOnRevenue_schedule_typeOther Value
- | SubscriptionAddOnRevenue_schedule_typeTyped Text
- | SubscriptionAddOnRevenue_schedule_typeEnumAt_range_end
- | SubscriptionAddOnRevenue_schedule_typeEnumAt_range_start
- | SubscriptionAddOnRevenue_schedule_typeEnumEvenly
- | SubscriptionAddOnRevenue_schedule_typeEnumNever
- data SubscriptionAddOnTier_type
- data SubscriptionAddOnUsage_calculation_type
- data SubscriptionAddOnUsage_timeframe
Documentation
data SubscriptionAddOn Source #
Defines the object schema located at components.schemas.SubscriptionAddOn in the specification.
This links an Add-on to a specific Subscription.
Constructors
| SubscriptionAddOn | |
Fields
| |
Instances
| FromJSON SubscriptionAddOn Source # | |
Defined in RecurlyClient.Types.SubscriptionAddOn Methods parseJSON :: Value -> Parser SubscriptionAddOn # parseJSONList :: Value -> Parser [SubscriptionAddOn] # | |
| ToJSON SubscriptionAddOn Source # | |
Defined in RecurlyClient.Types.SubscriptionAddOn Methods toJSON :: SubscriptionAddOn -> Value # toEncoding :: SubscriptionAddOn -> Encoding # toJSONList :: [SubscriptionAddOn] -> Value # toEncodingList :: [SubscriptionAddOn] -> Encoding # | |
| Show SubscriptionAddOn Source # | |
Defined in RecurlyClient.Types.SubscriptionAddOn Methods showsPrec :: Int -> SubscriptionAddOn -> ShowS # show :: SubscriptionAddOn -> String # showList :: [SubscriptionAddOn] -> ShowS # | |
| Eq SubscriptionAddOn Source # | |
Defined in RecurlyClient.Types.SubscriptionAddOn Methods (==) :: SubscriptionAddOn -> SubscriptionAddOn -> Bool # (/=) :: SubscriptionAddOn -> SubscriptionAddOn -> Bool # | |
mkSubscriptionAddOn :: SubscriptionAddOn Source #
Create a new SubscriptionAddOn with all required fields.
data SubscriptionAddOnAdd_on_source Source #
Defines the enum schema located at components.schemas.SubscriptionAddOn.properties.add_on_source in the specification.
Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
Constructors
| SubscriptionAddOnAdd_on_sourceOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| SubscriptionAddOnAdd_on_sourceTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| SubscriptionAddOnAdd_on_sourceEnumPlan_add_on | Represents the JSON value |
| SubscriptionAddOnAdd_on_sourceEnumItem | Represents the JSON value |
Instances
data SubscriptionAddOnRevenue_schedule_type Source #
Defines the enum schema located at components.schemas.SubscriptionAddOn.properties.revenue_schedule_type in the specification.
Constructors
| SubscriptionAddOnRevenue_schedule_typeOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| SubscriptionAddOnRevenue_schedule_typeTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| SubscriptionAddOnRevenue_schedule_typeEnumAt_range_end | Represents the JSON value |
| SubscriptionAddOnRevenue_schedule_typeEnumAt_range_start | Represents the JSON value |
| SubscriptionAddOnRevenue_schedule_typeEnumEvenly | Represents the JSON value |
| SubscriptionAddOnRevenue_schedule_typeEnumNever | Represents the JSON value |
Instances
data SubscriptionAddOnTier_type Source #
Defines the enum schema located at components.schemas.SubscriptionAddOn.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
| SubscriptionAddOnTier_typeOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| SubscriptionAddOnTier_typeTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| SubscriptionAddOnTier_typeEnumFlat | Represents the JSON value |
| SubscriptionAddOnTier_typeEnumTiered | Represents the JSON value |
| SubscriptionAddOnTier_typeEnumStairstep | Represents the JSON value |
| SubscriptionAddOnTier_typeEnumVolume | Represents the JSON value |
Instances
data SubscriptionAddOnUsage_calculation_type Source #
Defines the enum schema located at components.schemas.SubscriptionAddOn.properties.usage_calculation_type in the specification.
The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
Constructors
| SubscriptionAddOnUsage_calculation_typeOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| SubscriptionAddOnUsage_calculation_typeTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| SubscriptionAddOnUsage_calculation_typeEnumCumulative | Represents the JSON value |
| SubscriptionAddOnUsage_calculation_typeEnumLast_in_period | Represents the JSON value |
Instances
data SubscriptionAddOnUsage_timeframe Source #
Defines the enum schema located at components.schemas.SubscriptionAddOn.properties.usage_timeframe in the specification.
The time at which usage totals are reset for billing purposes.
Constructors
| SubscriptionAddOnUsage_timeframeOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| SubscriptionAddOnUsage_timeframeTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| SubscriptionAddOnUsage_timeframeEnumBilling_period | Represents the JSON value |
| SubscriptionAddOnUsage_timeframeEnumSubscription_term | Represents the JSON value |