| 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 String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> m (Either HttpException (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse))
- getSubscriptionItemsSubscriptionItemUsageRecordSummariesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> m (Either HttpException (Response ByteString))
- getSubscriptionItemsSubscriptionItemUsageRecordSummariesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse))
- getSubscriptionItemsSubscriptionItemUsageRecordSummariesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody = GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody {
- data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse
- data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 = GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 {
- getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Data :: [] UsageRecordSummary
- getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200HasMore :: Bool
- getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object :: GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object'
- getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Url :: String
- data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Object'
Documentation
getSubscriptionItemsSubscriptionItemUsageRecordSummaries Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | 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 String | 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 String | 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 |
| -> String | subscription_item |
| -> 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 String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/subscription_items/{subscription_item}/usage_record_summariesThe same as getSubscriptionItemsSubscriptionItemUsageRecordSummaries but returns the raw ByteString
getSubscriptionItemsSubscriptionItemUsageRecordSummariesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse)) Source #
GET /v1/subscription_items/{subscription_item}/usage_record_summariesMonadic version of getSubscriptionItemsSubscriptionItemUsageRecordSummaries (use with runWithConfiguration)
getSubscriptionItemsSubscriptionItemUsageRecordSummariesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/subscription_items/{subscription_item}/usage_record_summariesMonadic version of getSubscriptionItemsSubscriptionItemUsageRecordSummariesRaw (use with runWithConfiguration)
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody Source #
Defines the data type for the schema getSubscriptionItemsSubscriptionItemUsageRecordSummariesRequestBody
Instances
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
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 Source #
Defines the data type for the schema GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200
Constructors
| GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 | |
Fields
| |
Instances
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