| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetCustomersCustomerSubscriptions
Description
Contains the different functions to run the operation getCustomersCustomerSubscriptions
Synopsis
- getCustomersCustomerSubscriptions :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersCustomerSubscriptionsRequestBody -> m (Either HttpException (Response GetCustomersCustomerSubscriptionsResponse))
- getCustomersCustomerSubscriptionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersCustomerSubscriptionsRequestBody -> m (Either HttpException (Response ByteString))
- getCustomersCustomerSubscriptionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersCustomerSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCustomersCustomerSubscriptionsResponse))
- getCustomersCustomerSubscriptionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersCustomerSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetCustomersCustomerSubscriptionsRequestBody = GetCustomersCustomerSubscriptionsRequestBody {
- data GetCustomersCustomerSubscriptionsResponse
- data GetCustomersCustomerSubscriptionsResponseBody200 = GetCustomersCustomerSubscriptionsResponseBody200 {
- getCustomersCustomerSubscriptionsResponseBody200Data :: [] Subscription
- getCustomersCustomerSubscriptionsResponseBody200HasMore :: Bool
- getCustomersCustomerSubscriptionsResponseBody200Object :: GetCustomersCustomerSubscriptionsResponseBody200Object'
- getCustomersCustomerSubscriptionsResponseBody200Url :: String
- data GetCustomersCustomerSubscriptionsResponseBody200Object'
Documentation
getCustomersCustomerSubscriptions Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> String | customer | Constraints: Maximum length of 5000 |
| -> 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 |
| -> GetCustomersCustomerSubscriptionsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetCustomersCustomerSubscriptionsResponse)) | Monad containing the result of the operation |
GET /v1/customers/{customer}/subscriptions<p>You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.</p>
getCustomersCustomerSubscriptionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersCustomerSubscriptionsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/customers/{customer}/subscriptionsThe same as getCustomersCustomerSubscriptions but returns the raw ByteString
getCustomersCustomerSubscriptionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersCustomerSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCustomersCustomerSubscriptionsResponse)) Source #
GET /v1/customers/{customer}/subscriptionsMonadic version of getCustomersCustomerSubscriptions (use with runWithConfiguration)
getCustomersCustomerSubscriptionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersCustomerSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/customers/{customer}/subscriptionsMonadic version of getCustomersCustomerSubscriptionsRaw (use with runWithConfiguration)
data GetCustomersCustomerSubscriptionsRequestBody Source #
Defines the data type for the schema getCustomersCustomerSubscriptionsRequestBody
Constructors
| GetCustomersCustomerSubscriptionsRequestBody | |
Instances
data GetCustomersCustomerSubscriptionsResponse Source #
Represents a response of the operation getCustomersCustomerSubscriptions.
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), GetCustomersCustomerSubscriptionsResponseError is used.
Constructors
| GetCustomersCustomerSubscriptionsResponseError String | Means either no matching case available or a parse error |
| GetCustomersCustomerSubscriptionsResponse200 GetCustomersCustomerSubscriptionsResponseBody200 | Successful response. |
| GetCustomersCustomerSubscriptionsResponseDefault Error | Error response. |
data GetCustomersCustomerSubscriptionsResponseBody200 Source #
Defines the data type for the schema GetCustomersCustomerSubscriptionsResponseBody200
Constructors
| GetCustomersCustomerSubscriptionsResponseBody200 | |
Fields
| |
Instances
data GetCustomersCustomerSubscriptionsResponseBody200Object' Source #
Defines the enum schema GetCustomersCustomerSubscriptionsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors