{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE ExplicitForAll #-} {-# LANGUAGE MultiWayIf #-} {-# LANGUAGE DeriveGeneric #-} -- | Contains the different functions to run the operation postSubscriptionItemsSubscriptionItemUsageRecords module StripeAPI.Operations.PostSubscriptionItemsSubscriptionItemUsageRecords where import qualified Prelude as GHC.Integer.Type import qualified Prelude as GHC.Maybe import qualified Control.Monad.Trans.Reader import qualified Data.Aeson import qualified Data.Aeson as Data.Aeson.Types import qualified Data.Aeson as Data.Aeson.Types.FromJSON import qualified Data.Aeson as Data.Aeson.Types.ToJSON import qualified Data.Aeson as Data.Aeson.Types.Internal import qualified Data.ByteString.Char8 import qualified Data.ByteString.Char8 as Data.ByteString.Internal import qualified Data.Either import qualified Data.Functor import qualified Data.Scientific import qualified Data.Text import qualified Data.Text.Internal import qualified Data.Time.Calendar as Data.Time.Calendar.Days import qualified Data.Time.LocalTime as Data.Time.LocalTime.Internal.ZonedTime import qualified GHC.Base import qualified GHC.Classes import qualified GHC.Generics import qualified GHC.Int import qualified GHC.Show import qualified GHC.Types import qualified Network.HTTP.Client import qualified Network.HTTP.Client as Network.HTTP.Client.Request import qualified Network.HTTP.Client as Network.HTTP.Client.Types import qualified Network.HTTP.Simple import qualified Network.HTTP.Types import qualified Network.HTTP.Types as Network.HTTP.Types.Status import qualified Network.HTTP.Types as Network.HTTP.Types.URI import qualified StripeAPI.Common import StripeAPI.Types -- | > POST /v1/subscription_items/{subscription_item}/usage_records -- -- \

Creates a usage record for a specified subscription item and date, and fills it with a quantity.\<\/p> -- -- \

Usage records provide \quantity\<\/code> information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the \metered billing\<\/a> plan, Stripe helps you send accurate invoices to your customers.\<\/p> -- -- \

The default calculation for usage is to add up all the \quantity\<\/code> values of the usage records within a billing period. You can change this default behavior with the billing plan’s \aggregate_usage\<\/code> \parameter\<\/a>. When there is more than one usage record with the same timestamp, Stripe adds the \quantity\<\/code> values together. In most cases, this is the desired resolution, however, you can change this behavior with the \action\<\/code> parameter.\<\/p> -- -- \

The default pricing model for metered billing is \per-unit pricing\<\/a>. For finer granularity, you can configure metered billing to have a \tiered pricing\<\/a> model.\<\/p> postSubscriptionItemsSubscriptionItemUsageRecords :: forall m s . (StripeAPI.Common.MonadHTTP m, StripeAPI.Common.SecurityScheme s) => StripeAPI.Common.Configuration s -- ^ The configuration to use in the request -> GHC.Base.String -- ^ subscription_item -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -- ^ The request body to send -> m (Data.Either.Either Network.HTTP.Client.Types.HttpException (Network.HTTP.Client.Types.Response PostSubscriptionItemsSubscriptionItemUsageRecordsResponse)) -- ^ Monad containing the result of the operation postSubscriptionItemsSubscriptionItemUsageRecords config subscriptionItem body = GHC.Base.fmap (GHC.Base.fmap (\response_0 -> GHC.Base.fmap (Data.Either.either PostSubscriptionItemsSubscriptionItemUsageRecordsResponseError GHC.Base.id GHC.Base.. (\response body -> if | (\status_1 -> Network.HTTP.Types.Status.statusCode status_1 GHC.Classes.== 200) (Network.HTTP.Client.Types.responseStatus response) -> PostSubscriptionItemsSubscriptionItemUsageRecordsResponse200 Data.Functor.<$> (Data.Aeson.eitherDecodeStrict body :: Data.Either.Either GHC.Base.String UsageRecord) | GHC.Base.const GHC.Types.True (Network.HTTP.Client.Types.responseStatus response) -> PostSubscriptionItemsSubscriptionItemUsageRecordsResponseDefault Data.Functor.<$> (Data.Aeson.eitherDecodeStrict body :: Data.Either.Either GHC.Base.String Error) | GHC.Base.otherwise -> Data.Either.Left "Missing default response type") response_0) response_0)) (StripeAPI.Common.doBodyCallWithConfiguration config (Data.Text.toUpper (Data.Text.pack "POST")) (Data.Text.pack ("/v1/subscription_items/" GHC.Base.++ (Data.ByteString.Char8.unpack (Network.HTTP.Types.URI.urlEncode GHC.Types.True GHC.Base.$ (Data.ByteString.Char8.pack GHC.Base.$ StripeAPI.Common.stringifyModel subscriptionItem)) GHC.Base.++ "/usage_records"))) [] body StripeAPI.Common.RequestBodyEncodingFormData) -- | > POST /v1/subscription_items/{subscription_item}/usage_records -- -- The same as 'postSubscriptionItemsSubscriptionItemUsageRecords' but returns the raw 'Data.ByteString.Char8.ByteString' postSubscriptionItemsSubscriptionItemUsageRecordsRaw :: forall m s . (StripeAPI.Common.MonadHTTP m, StripeAPI.Common.SecurityScheme s) => StripeAPI.Common.Configuration s -> GHC.Base.String -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> m (Data.Either.Either Network.HTTP.Client.Types.HttpException (Network.HTTP.Client.Types.Response Data.ByteString.Internal.ByteString)) postSubscriptionItemsSubscriptionItemUsageRecordsRaw config subscriptionItem body = GHC.Base.id (StripeAPI.Common.doBodyCallWithConfiguration config (Data.Text.toUpper (Data.Text.pack "POST")) (Data.Text.pack ("/v1/subscription_items/" GHC.Base.++ (Data.ByteString.Char8.unpack (Network.HTTP.Types.URI.urlEncode GHC.Types.True GHC.Base.$ (Data.ByteString.Char8.pack GHC.Base.$ StripeAPI.Common.stringifyModel subscriptionItem)) GHC.Base.++ "/usage_records"))) [] body StripeAPI.Common.RequestBodyEncodingFormData) -- | > POST /v1/subscription_items/{subscription_item}/usage_records -- -- Monadic version of 'postSubscriptionItemsSubscriptionItemUsageRecords' (use with 'StripeAPI.Common.runWithConfiguration') postSubscriptionItemsSubscriptionItemUsageRecordsM :: forall m s . (StripeAPI.Common.MonadHTTP m, StripeAPI.Common.SecurityScheme s) => GHC.Base.String -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> Control.Monad.Trans.Reader.ReaderT (StripeAPI.Common.Configuration s) m (Data.Either.Either Network.HTTP.Client.Types.HttpException (Network.HTTP.Client.Types.Response PostSubscriptionItemsSubscriptionItemUsageRecordsResponse)) postSubscriptionItemsSubscriptionItemUsageRecordsM subscriptionItem body = GHC.Base.fmap (GHC.Base.fmap (\response_2 -> GHC.Base.fmap (Data.Either.either PostSubscriptionItemsSubscriptionItemUsageRecordsResponseError GHC.Base.id GHC.Base.. (\response body -> if | (\status_3 -> Network.HTTP.Types.Status.statusCode status_3 GHC.Classes.== 200) (Network.HTTP.Client.Types.responseStatus response) -> PostSubscriptionItemsSubscriptionItemUsageRecordsResponse200 Data.Functor.<$> (Data.Aeson.eitherDecodeStrict body :: Data.Either.Either GHC.Base.String UsageRecord) | GHC.Base.const GHC.Types.True (Network.HTTP.Client.Types.responseStatus response) -> PostSubscriptionItemsSubscriptionItemUsageRecordsResponseDefault Data.Functor.<$> (Data.Aeson.eitherDecodeStrict body :: Data.Either.Either GHC.Base.String Error) | GHC.Base.otherwise -> Data.Either.Left "Missing default response type") response_2) response_2)) (StripeAPI.Common.doBodyCallWithConfigurationM (Data.Text.toUpper (Data.Text.pack "POST")) (Data.Text.pack ("/v1/subscription_items/" GHC.Base.++ (Data.ByteString.Char8.unpack (Network.HTTP.Types.URI.urlEncode GHC.Types.True GHC.Base.$ (Data.ByteString.Char8.pack GHC.Base.$ StripeAPI.Common.stringifyModel subscriptionItem)) GHC.Base.++ "/usage_records"))) [] body StripeAPI.Common.RequestBodyEncodingFormData) -- | > POST /v1/subscription_items/{subscription_item}/usage_records -- -- Monadic version of 'postSubscriptionItemsSubscriptionItemUsageRecordsRaw' (use with 'StripeAPI.Common.runWithConfiguration') postSubscriptionItemsSubscriptionItemUsageRecordsRawM :: forall m s . (StripeAPI.Common.MonadHTTP m, StripeAPI.Common.SecurityScheme s) => GHC.Base.String -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> Control.Monad.Trans.Reader.ReaderT (StripeAPI.Common.Configuration s) m (Data.Either.Either Network.HTTP.Client.Types.HttpException (Network.HTTP.Client.Types.Response Data.ByteString.Internal.ByteString)) postSubscriptionItemsSubscriptionItemUsageRecordsRawM subscriptionItem body = GHC.Base.id (StripeAPI.Common.doBodyCallWithConfigurationM (Data.Text.toUpper (Data.Text.pack "POST")) (Data.Text.pack ("/v1/subscription_items/" GHC.Base.++ (Data.ByteString.Char8.unpack (Network.HTTP.Types.URI.urlEncode GHC.Types.True GHC.Base.$ (Data.ByteString.Char8.pack GHC.Base.$ StripeAPI.Common.stringifyModel subscriptionItem)) GHC.Base.++ "/usage_records"))) [] body StripeAPI.Common.RequestBodyEncodingFormData) -- | Defines the data type for the schema postSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -- -- data PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody = PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody { -- | action: Valid values are \`increment\` (default) or \`set\`. When using \`increment\` the specified \`quantity\` will be added to the usage at the specified timestamp. The \`set\` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https:\/\/stripe.com\/docs\/api\/subscriptions\/object\#subscription_object-billing_thresholds), \`increment\` is the only allowed value. -- -- Constraints: -- -- * Maximum length of 5000 postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction :: (GHC.Maybe.Maybe PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction') -- | expand: Specifies which fields in the response should be expanded. , postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyExpand :: (GHC.Maybe.Maybe ([] GHC.Base.String)) -- | quantity: The usage quantity for the specified timestamp. , postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyQuantity :: GHC.Integer.Type.Integer -- | timestamp: The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided \`subscription_item\`. , postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyTimestamp :: GHC.Integer.Type.Integer } deriving (GHC.Show.Show , GHC.Classes.Eq) instance Data.Aeson.ToJSON PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody where toJSON obj = Data.Aeson.object ((Data.Aeson..=) "action" (postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction obj) : (Data.Aeson..=) "expand" (postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyExpand obj) : (Data.Aeson..=) "quantity" (postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyQuantity obj) : (Data.Aeson..=) "timestamp" (postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyTimestamp obj) : []) toEncoding obj = Data.Aeson.pairs ((Data.Aeson..=) "action" (postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction obj) GHC.Base.<> ((Data.Aeson..=) "expand" (postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyExpand obj) GHC.Base.<> ((Data.Aeson..=) "quantity" (postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyQuantity obj) GHC.Base.<> (Data.Aeson..=) "timestamp" (postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyTimestamp obj)))) instance Data.Aeson.Types.FromJSON.FromJSON PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody where parseJSON = Data.Aeson.Types.FromJSON.withObject "PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody" (\obj -> (((GHC.Base.pure PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody GHC.Base.<*> (obj Data.Aeson.Types.FromJSON..:? "action")) GHC.Base.<*> (obj Data.Aeson.Types.FromJSON..:? "expand")) GHC.Base.<*> (obj Data.Aeson.Types.FromJSON..: "quantity")) GHC.Base.<*> (obj Data.Aeson.Types.FromJSON..: "timestamp")) -- | Defines the enum schema postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction\' -- -- Valid values are \`increment\` (default) or \`set\`. When using \`increment\` the specified \`quantity\` will be added to the usage at the specified timestamp. The \`set\` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https:\/\/stripe.com\/docs\/api\/subscriptions\/object\#subscription_object-billing_thresholds), \`increment\` is the only allowed value. data PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction' = PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumOther Data.Aeson.Types.Internal.Value | PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumTyped GHC.Base.String | PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumStringIncrement | PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumStringSet deriving (GHC.Show.Show, GHC.Classes.Eq) instance Data.Aeson.ToJSON PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction' where toJSON (PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumOther patternName) = Data.Aeson.Types.ToJSON.toJSON patternName toJSON (PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumTyped patternName) = Data.Aeson.Types.ToJSON.toJSON patternName toJSON (PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumStringIncrement) = Data.Aeson.Types.Internal.String GHC.Base.$ Data.Text.pack "increment" toJSON (PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumStringSet) = Data.Aeson.Types.Internal.String GHC.Base.$ Data.Text.pack "set" instance Data.Aeson.FromJSON PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction' where parseJSON val = GHC.Base.pure (if val GHC.Classes.== (Data.Aeson.Types.Internal.String GHC.Base.$ Data.Text.pack "increment") then PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumStringIncrement else if val GHC.Classes.== (Data.Aeson.Types.Internal.String GHC.Base.$ Data.Text.pack "set") then PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumStringSet else PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumOther val) -- | Represents a response of the operation 'postSubscriptionItemsSubscriptionItemUsageRecords'. -- -- The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), 'PostSubscriptionItemsSubscriptionItemUsageRecordsResponseError' is used. data PostSubscriptionItemsSubscriptionItemUsageRecordsResponse = PostSubscriptionItemsSubscriptionItemUsageRecordsResponseError GHC.Base.String -- ^ Means either no matching case available or a parse error | PostSubscriptionItemsSubscriptionItemUsageRecordsResponse200 UsageRecord -- ^ Successful response. | PostSubscriptionItemsSubscriptionItemUsageRecordsResponseDefault Error -- ^ Error response. deriving (GHC.Show.Show, GHC.Classes.Eq)