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 -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerSubscriptionsRequestBody -> m (Either HttpException (Response GetCustomersCustomerSubscriptionsResponse))
getCustomersCustomerSubscriptionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerSubscriptionsRequestBody -> m (Either HttpException (Response ByteString))
getCustomersCustomerSubscriptionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCustomersCustomerSubscriptionsResponse))
getCustomersCustomerSubscriptionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetCustomersCustomerSubscriptionsRequestBody = GetCustomersCustomerSubscriptionsRequestBody {
}
data GetCustomersCustomerSubscriptionsResponse
data GetCustomersCustomerSubscriptionsResponseBody200 = GetCustomersCustomerSubscriptionsResponseBody200 {
}
data GetCustomersCustomerSubscriptionsResponseBody200Object'

Documentation

getCustomersCustomerSubscriptions Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	customer \| Constraints: Maximum length of 5000
-> Maybe Text	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 Text	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 Text	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
-> Maybe 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 -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerSubscriptionsRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/customers/{customer}/subscriptions

The same as getCustomersCustomerSubscriptions but returns the raw ByteString

getCustomersCustomerSubscriptionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCustomersCustomerSubscriptionsResponse)) Source #

GET /v1/customers/{customer}/subscriptions

Monadic version of getCustomersCustomerSubscriptions (use with runWithConfiguration)

getCustomersCustomerSubscriptionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/customers/{customer}/subscriptions

Monadic version of getCustomersCustomerSubscriptionsRaw (use with runWithConfiguration)

data GetCustomersCustomerSubscriptionsRequestBody Source #

Defines the data type for the schema getCustomersCustomerSubscriptionsRequestBody

Constructors

GetCustomersCustomerSubscriptionsRequestBody

Instances

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

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.

Instances

Eq GetCustomersCustomerSubscriptionsResponse Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions Methods (==) :: GetCustomersCustomerSubscriptionsResponse -> GetCustomersCustomerSubscriptionsResponse -> Bool # (/=) :: GetCustomersCustomerSubscriptionsResponse -> GetCustomersCustomerSubscriptionsResponse -> Bool #
Show GetCustomersCustomerSubscriptionsResponse Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions Methods showsPrec :: Int -> GetCustomersCustomerSubscriptionsResponse -> ShowS # show :: GetCustomersCustomerSubscriptionsResponse -> String # showList :: [GetCustomersCustomerSubscriptionsResponse] -> ShowS #

data GetCustomersCustomerSubscriptionsResponseBody200 Source #

Defines the data type for the schema GetCustomersCustomerSubscriptionsResponseBody200

Constructors

GetCustomersCustomerSubscriptionsResponseBody200

Fields

getCustomersCustomerSubscriptionsResponseBody200Data :: [] Subscription
data: Details about each object.
getCustomersCustomerSubscriptionsResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getCustomersCustomerSubscriptionsResponseBody200Object :: GetCustomersCustomerSubscriptionsResponseBody200Object'
object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
getCustomersCustomerSubscriptionsResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000

Instances

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

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

GetCustomersCustomerSubscriptionsResponseBody200Object'EnumOther Value
GetCustomersCustomerSubscriptionsResponseBody200Object'EnumTyped Text
GetCustomersCustomerSubscriptionsResponseBody200Object'EnumStringList

Instances

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