Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostSubscriptionItemsSubscriptionItemUsageRecords

Description

Contains the different functions to run the operation postSubscriptionItemsSubscriptionItemUsageRecords

Synopsis

postSubscriptionItemsSubscriptionItemUsageRecords :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> m (Either HttpException (Response PostSubscriptionItemsSubscriptionItemUsageRecordsResponse))
postSubscriptionItemsSubscriptionItemUsageRecordsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> m (Either HttpException (Response ByteString))
postSubscriptionItemsSubscriptionItemUsageRecordsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionItemsSubscriptionItemUsageRecordsResponse))
postSubscriptionItemsSubscriptionItemUsageRecordsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody = PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody {
}
data PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'
data PostSubscriptionItemsSubscriptionItemUsageRecordsResponse

Documentation

postSubscriptionItemsSubscriptionItemUsageRecords Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	subscription_item
-> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody	The request body to send
-> m (Either HttpException (Response PostSubscriptionItemsSubscriptionItemUsageRecordsResponse))	Monad containing the result of the operation

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.

Usage records provide <code>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 <a href="https://stripe.com/docs/billing/subscriptions/metered-billing">metered billing</a> plan, Stripe helps you send accurate invoices to your customers.

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

The default pricing model for metered billing is <a href="/docs/api/plans/object#plan_object-billing_scheme">per-unit pricing</a>. For finer granularity, you can configure metered billing to have a <a href="https://stripe.com/docs/billing/subscriptions/tiers">tiered pricing</a> model.

postSubscriptionItemsSubscriptionItemUsageRecordsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/subscription_items/{subscription_item}/usage_records

The same as postSubscriptionItemsSubscriptionItemUsageRecords but returns the raw ByteString

postSubscriptionItemsSubscriptionItemUsageRecordsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionItemsSubscriptionItemUsageRecordsResponse)) Source #

POST /v1/subscription_items/{subscription_item}/usage_records

Monadic version of postSubscriptionItemsSubscriptionItemUsageRecords (use with runWithConfiguration)

postSubscriptionItemsSubscriptionItemUsageRecordsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/subscription_items/{subscription_item}/usage_records

Monadic version of postSubscriptionItemsSubscriptionItemUsageRecordsRaw (use with runWithConfiguration)

data PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody Source #

Defines the data type for the schema postSubscriptionItemsSubscriptionItemUsageRecordsRequestBody

Constructors

PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBody

Fields

postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction :: Maybe PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'
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, `increment` is the only allowed value.
Constraints:
- Maximum length of 5000
postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyQuantity :: Integer
quantity: The usage quantity for the specified timestamp.
postSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyTimestamp :: 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`.

Instances

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

data PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction' Source #

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, `increment` is the only allowed value.

Constructors

PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumOther Value
PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumTyped Text
PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumStringIncrement
PostSubscriptionItemsSubscriptionItemUsageRecordsRequestBodyAction'EnumStringSet

Instances

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

data PostSubscriptionItemsSubscriptionItemUsageRecordsResponse Source #

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.

Constructors

PostSubscriptionItemsSubscriptionItemUsageRecordsResponseError String	Means either no matching case available or a parse error
PostSubscriptionItemsSubscriptionItemUsageRecordsResponse200 UsageRecord	Successful response.
PostSubscriptionItemsSubscriptionItemUsageRecordsResponseDefault Error	Error response.

Instances

Eq PostSubscriptionItemsSubscriptionItemUsageRecordsResponse Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsSubscriptionItemUsageRecords Methods (==) :: PostSubscriptionItemsSubscriptionItemUsageRecordsResponse -> PostSubscriptionItemsSubscriptionItemUsageRecordsResponse -> Bool # (/=) :: PostSubscriptionItemsSubscriptionItemUsageRecordsResponse -> PostSubscriptionItemsSubscriptionItemUsageRecordsResponse -> Bool #
Show PostSubscriptionItemsSubscriptionItemUsageRecordsResponse Source #
Instance details Defined in StripeAPI.Operations.PostSubscriptionItemsSubscriptionItemUsageRecords Methods showsPrec :: Int -> PostSubscriptionItemsSubscriptionItemUsageRecordsResponse -> ShowS # show :: PostSubscriptionItemsSubscriptionItemUsageRecordsResponse -> String # showList :: [PostSubscriptionItemsSubscriptionItemUsageRecordsResponse] -> ShowS #