Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries

Contains the different functions to run the operation getSubscriptionItemsSubscriptionItemUsageRecordSummaries

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetSubscriptionItemsSubscriptionItemUsageRecordSummaries.hs

valuegetSubscriptionItemsSubscriptionItemUsageRecordSummaries

:: MonadHTTP m
=> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT 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>

datadata GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters

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

Constructors

GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters
- 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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries
Show GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries
FromJSON GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries
ToJSON GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries

valuemkGetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters

:: Text
getSubscriptionItemsSubscriptionItemUsageRecordSummariesParametersPathSubscriptionItem
-> GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters

Create a new GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParameters with all required fields.

datadata GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse

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.

Instances2Eq, Show

Eq GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries
Show GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries

datadata GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries
Show GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries
FromJSON GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries
ToJSON GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries

valuemkGetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200

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

Create a new GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseBody200 with all required fields.