| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetSubscriptionItems
Description
Contains the different functions to run the operation getSubscriptionItems
Synopsis
- getSubscriptionItems :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsRequestBody -> m (Either HttpException (Response GetSubscriptionItemsResponse))
- getSubscriptionItemsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsRequestBody -> m (Either HttpException (Response ByteString))
- getSubscriptionItemsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionItemsResponse))
- getSubscriptionItemsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetSubscriptionItemsRequestBody = GetSubscriptionItemsRequestBody {
- data GetSubscriptionItemsResponse
- data GetSubscriptionItemsResponseBody200 = GetSubscriptionItemsResponseBody200 {}
- data GetSubscriptionItemsResponseBody200Object'
Documentation
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. |
| -> 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. |
| -> String | subscription: The ID of the subscription whose items will be retrieved. | Constraints: Maximum length of 5000 |
| -> GetSubscriptionItemsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetSubscriptionItemsResponse)) | Monad containing the result of the operation |
GET /v1/subscription_items
<p>Returns a list of your subscription items for a given subscription.</p>
getSubscriptionItemsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/subscription_items
The same as getSubscriptionItems but returns the raw ByteString
getSubscriptionItemsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionItemsResponse)) Source #
GET /v1/subscription_items
Monadic version of getSubscriptionItems (use with runWithConfiguration)
getSubscriptionItemsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetSubscriptionItemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/subscription_items
Monadic version of getSubscriptionItemsRaw (use with runWithConfiguration)
data GetSubscriptionItemsRequestBody Source #
Defines the data type for the schema getSubscriptionItemsRequestBody
Constructors
| GetSubscriptionItemsRequestBody | |
Instances
data GetSubscriptionItemsResponse Source #
Represents a response of the operation getSubscriptionItems.
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), GetSubscriptionItemsResponseError is used.
Constructors
| GetSubscriptionItemsResponseError String | Means either no matching case available or a parse error |
| GetSubscriptionItemsResponse200 GetSubscriptionItemsResponseBody200 | Successful response. |
| GetSubscriptionItemsResponseDefault Error | Error response. |
Instances
| Eq GetSubscriptionItemsResponse Source # | |
Defined in StripeAPI.Operations.GetSubscriptionItems Methods (==) :: GetSubscriptionItemsResponse -> GetSubscriptionItemsResponse -> Bool # (/=) :: GetSubscriptionItemsResponse -> GetSubscriptionItemsResponse -> Bool # | |
| Show GetSubscriptionItemsResponse Source # | |
Defined in StripeAPI.Operations.GetSubscriptionItems Methods showsPrec :: Int -> GetSubscriptionItemsResponse -> ShowS # show :: GetSubscriptionItemsResponse -> String # showList :: [GetSubscriptionItemsResponse] -> ShowS # | |
data GetSubscriptionItemsResponseBody200 Source #
Defines the data type for the schema GetSubscriptionItemsResponseBody200
Constructors
| GetSubscriptionItemsResponseBody200 | |
Fields
| |
Instances
data GetSubscriptionItemsResponseBody200Object' Source #
Defines the enum schema GetSubscriptionItemsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetSubscriptionItemsResponseBody200Object'EnumOther Value | |
| GetSubscriptionItemsResponseBody200Object'EnumTyped String | |
| GetSubscriptionItemsResponseBody200Object'EnumStringList |