Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries

Description

Contains the different functions to run the operation getSubscriptionItemsSubscriptionItemUsageRecordSummaries

Synopsis

getSubscriptionItemsSubscriptionItemUsageRecordSummaries :: forall m. MonadHTTP m => GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters -> StripeT m (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse)
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters = GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters {
}
mkGetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters :: Text -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse
data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 = GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 {
}
mkGetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 :: [UsageRecordSummary] -> Bool -> Text -> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200

Documentation

getSubscriptionItemsSubscriptionItemUsageRecordSummaries Source #

Arguments

:: forall m. MonadHTTP m
=> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters	Contains all available parameters of this operation (query and path parameters)
-> StripeT m (Response GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse)	Monadic computation which returns 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 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>

data GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters Source #

Defines the object schema located at paths./v1/subscription_items/{subscription_item}/usage_record_summaries.GET.parameters in the specification.

Constructors

GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters

Fields

getSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersPathSubscriptionItem :: Text
pathSubscription_item: Represents the parameter named 'subscription_item'
getSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named '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
getSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named '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

Instances

Instances details

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

mkGetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters Source #

Arguments

:: Text	`getSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersPathSubscriptionItem`
-> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters

Create a new GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters with all required fields.

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

Instances details

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 object schema located at paths./v1/subscription_items/{subscription_item}/usage_record_summaries.GET.responses.200.content.application/json.schema in the specification.

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.
getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000

Instances

Instances details

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] #

mkGetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 Source #

Arguments

:: [UsageRecordSummary]	`getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Data`
-> Bool	`getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200HasMore`
-> Text	`getSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Url`
-> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200

Create a new GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 with all required fields.