Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries

Description

Contains the different functions to run the operation getSubscriptionItemsSubscriptionItemUsageRecordSummaries

Synopsis

getSubscriptionItemsSubscriptionItemUsageRecordSummaries :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Text -> Maybe GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> m (Either HttpException (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse))
getSubscriptionItemsSubscriptionItemUsageRecordSummariesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Text -> Maybe GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> m (Either HttpException (Response ByteString))
getSubscriptionItemsSubscriptionItemUsageRecordSummariesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Text -> Maybe GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse))
getSubscriptionItemsSubscriptionItemUsageRecordSummariesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Text -> Maybe GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody = GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody {
}
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 = GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 {
}
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object'

Documentation

getSubscriptionItemsSubscriptionItemUsageRecordSummaries Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Maybe Text	ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. \| Constraints: Maximum length of 5000
-> Maybe Text	expand: Specifies which fields in the response should be expanded.
-> Maybe Integer	limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-> Maybe Text	starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. \| Constraints: Maximum length of 5000
-> Text	subscription_item
-> Maybe GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody	The request body to send
-> m (Either HttpException (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse))	Monad containing the result of the operation

GET /v1/subscription_items/{subscription_item}/usage_record_summaries

<p>For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the billing plan’s month of September).</p>

<p>The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.</p>

getSubscriptionItemsSubscriptionItemUsageRecordSummariesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Text -> Maybe GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/subscription_items/{subscription_item}/usage_record_summaries

The same as getSubscriptionItemsSubscriptionItemUsageRecordSummaries but returns the raw ByteString

getSubscriptionItemsSubscriptionItemUsageRecordSummariesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Text -> Maybe GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse)) Source #

GET /v1/subscription_items/{subscription_item}/usage_record_summaries

Monadic version of getSubscriptionItemsSubscriptionItemUsageRecordSummaries (use with runWithConfiguration)

getSubscriptionItemsSubscriptionItemUsageRecordSummariesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Text -> Maybe GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/subscription_items/{subscription_item}/usage_record_summaries

Monadic version of getSubscriptionItemsSubscriptionItemUsageRecordSummariesRaw (use with runWithConfiguration)

data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody Source #

Defines the data type for the schema getSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody

Constructors

GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody

Instances

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

data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse Source #

Represents a response of the operation getSubscriptionItemsSubscriptionItemUsageRecordSummaries.

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), GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseError is used.

Constructors

GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseError String	Means either no matching case available or a parse error
GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse200 GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200	Successful response.
GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseDefault Error	Error response.

Instances

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

data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 Source #

Defines the data type for the schema GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200

Constructors

GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200

Fields

getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Data :: [] UsageRecordSummary
data
getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object :: GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object'
object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000

Instances

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

data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object' Source #

Defines the enum schema GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object'EnumOther Value
GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object'EnumTyped Text
GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object'EnumStringList

Instances

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