Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetChargesChargeRefunds

Description

Contains the different functions to run the operation getChargesChargeRefunds

Synopsis

getChargesChargeRefunds :: forall m. MonadHTTP m => GetChargesChargeRefundsParameters -> StripeT m (Response GetChargesChargeRefundsResponse)
data GetChargesChargeRefundsParameters = GetChargesChargeRefundsParameters {
}
mkGetChargesChargeRefundsParameters :: Text -> GetChargesChargeRefundsParameters
data GetChargesChargeRefundsResponse
data GetChargesChargeRefundsResponseBody200 = GetChargesChargeRefundsResponseBody200 {
}
mkGetChargesChargeRefundsResponseBody200 :: [Refund] -> Bool -> Text -> GetChargesChargeRefundsResponseBody200

Documentation

getChargesChargeRefunds Source #

Arguments

:: forall m. MonadHTTP m
=> GetChargesChargeRefundsParameters	Contains all available parameters of this operation (query and path parameters)
-> StripeT m (Response GetChargesChargeRefundsResponse)	Monadic computation which returns the result of the operation

GET /v1/charges/{charge}/refunds

<p>You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p>

data GetChargesChargeRefundsParameters Source #

Defines the object schema located at paths./v1/charges/{charge}/refunds.GET.parameters in the specification.

Constructors

GetChargesChargeRefundsParameters

Fields

getChargesChargeRefundsParametersPathCharge :: Text
pathCharge: Represents the parameter named 'charge'
getChargesChargeRefundsParametersQueryEndingBefore :: 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.
getChargesChargeRefundsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getChargesChargeRefundsParametersQueryLimit :: 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.
getChargesChargeRefundsParametersQueryStartingAfter :: 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.

Instances

Instances details

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

mkGetChargesChargeRefundsParameters Source #

Arguments

:: Text	`getChargesChargeRefundsParametersPathCharge`
-> GetChargesChargeRefundsParameters

Create a new GetChargesChargeRefundsParameters with all required fields.

data GetChargesChargeRefundsResponse Source #

Represents a response of the operation getChargesChargeRefunds.

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), GetChargesChargeRefundsResponseError is used.

Constructors

GetChargesChargeRefundsResponseError String	Means either no matching case available or a parse error
GetChargesChargeRefundsResponse200 GetChargesChargeRefundsResponseBody200	Successful response.
GetChargesChargeRefundsResponseDefault Error	Error response.

Instances

Instances details

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

data GetChargesChargeRefundsResponseBody200 Source #

Defines the object schema located at paths./v1/charges/{charge}/refunds.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetChargesChargeRefundsResponseBody200
Fields getChargesChargeRefundsResponseBody200Data :: [Refund] data: Details about each object. getChargesChargeRefundsResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getChargesChargeRefundsResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000

Instances

Instances details

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

mkGetChargesChargeRefundsResponseBody200 Source #

Arguments

:: [Refund]	`getChargesChargeRefundsResponseBody200Data`
-> Bool	`getChargesChargeRefundsResponseBody200HasMore`
-> Text	`getChargesChargeRefundsResponseBody200Url`
-> GetChargesChargeRefundsResponseBody200

Create a new GetChargesChargeRefundsResponseBody200 with all required fields.