StripeAPI.Operations.GetRefunds

Contains the different functions to run the operation getRefunds

Documentation

getRefunds

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

charge: Only return refunds for the charge specified by this charge ID.

-> Maybe Text

created

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

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

payment_intent: Only return refunds for the PaymentIntent specified by this ID. | Constraints: Maximum length of 5000

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

-> Maybe GetRefundsRequestBody

The request body to send

-> m (Either HttpException (Response GetRefundsResponse))

Monad containing the result of the operation

GET /v1/refunds

<p>Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.</p>

getRefundsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetRefundsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/refunds

The same as getRefunds but returns the raw ByteString

getRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetRefundsResponse))

GET /v1/refunds

Monadic version of getRefunds (use with runWithConfiguration)

getRefundsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/refunds

Monadic version of getRefundsRaw (use with runWithConfiguration)

data GetRefundsRequestBody

Defines the data type for the schema getRefundsRequestBody

Constructors

GetRefundsRequestBody

Instances

Eq GetRefundsRequestBody

Defined in StripeAPI.Operations.GetRefunds

Methods

(==) :: GetRefundsRequestBody -> GetRefundsRequestBody -> Bool

(/=) :: GetRefundsRequestBody -> GetRefundsRequestBody -> Bool

Show GetRefundsRequestBody

Defined in StripeAPI.Operations.GetRefunds

Methods

showsPrec :: Int -> GetRefundsRequestBody -> ShowS

show :: GetRefundsRequestBody -> String

showList :: [GetRefundsRequestBody] -> ShowS

ToJSON GetRefundsRequestBody

Defined in StripeAPI.Operations.GetRefunds

Methods

toJSON :: GetRefundsRequestBody -> Value

toEncoding :: GetRefundsRequestBody -> Encoding

toJSONList :: [GetRefundsRequestBody] -> Value

toEncodingList :: [GetRefundsRequestBody] -> Encoding

FromJSON GetRefundsRequestBody

Defined in StripeAPI.Operations.GetRefunds

Methods

parseJSON :: Value -> Parser GetRefundsRequestBody

parseJSONList :: Value -> Parser [GetRefundsRequestBody]

data GetRefundsResponse

Represents a response of the operation getRefunds.

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

Constructors

GetRefundsResponseError String

Means either no matching case available or a parse error

GetRefundsResponse200 GetRefundsResponseBody200

Successful response.

GetRefundsResponseDefault Error

Error response.

Instances

Eq GetRefundsResponse

Defined in StripeAPI.Operations.GetRefunds

Methods

(==) :: GetRefundsResponse -> GetRefundsResponse -> Bool

(/=) :: GetRefundsResponse -> GetRefundsResponse -> Bool

Show GetRefundsResponse

Defined in StripeAPI.Operations.GetRefunds

Methods

showsPrec :: Int -> GetRefundsResponse -> ShowS

show :: GetRefundsResponse -> String

showList :: [GetRefundsResponse] -> ShowS

data GetRefundsResponseBody200

Defines the data type for the schema GetRefundsResponseBody200

Constructors

GetRefundsResponseBody200

Fields

• getRefundsResponseBody200Data :: [] Refund

  data

• getRefundsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getRefundsResponseBody200Object :: GetRefundsResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getRefundsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/refunds'

Instances

Eq GetRefundsResponseBody200

Defined in StripeAPI.Operations.GetRefunds

Methods

(==) :: GetRefundsResponseBody200 -> GetRefundsResponseBody200 -> Bool

(/=) :: GetRefundsResponseBody200 -> GetRefundsResponseBody200 -> Bool

Show GetRefundsResponseBody200

Defined in StripeAPI.Operations.GetRefunds

Methods

showsPrec :: Int -> GetRefundsResponseBody200 -> ShowS

show :: GetRefundsResponseBody200 -> String

showList :: [GetRefundsResponseBody200] -> ShowS

ToJSON GetRefundsResponseBody200

Defined in StripeAPI.Operations.GetRefunds

Methods

toJSON :: GetRefundsResponseBody200 -> Value

toEncoding :: GetRefundsResponseBody200 -> Encoding

toJSONList :: [GetRefundsResponseBody200] -> Value

toEncodingList :: [GetRefundsResponseBody200] -> Encoding

FromJSON GetRefundsResponseBody200

Defined in StripeAPI.Operations.GetRefunds

Methods

parseJSON :: Value -> Parser GetRefundsResponseBody200

parseJSONList :: Value -> Parser [GetRefundsResponseBody200]

data GetRefundsResponseBody200Object'

Defines the enum schema GetRefundsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetRefundsResponseBody200Object'EnumOther Value

GetRefundsResponseBody200Object'EnumTyped Text

GetRefundsResponseBody200Object'EnumStringList

Instances

Eq GetRefundsResponseBody200Object'

Defined in StripeAPI.Operations.GetRefunds

Methods

(==) :: GetRefundsResponseBody200Object' -> GetRefundsResponseBody200Object' -> Bool

(/=) :: GetRefundsResponseBody200Object' -> GetRefundsResponseBody200Object' -> Bool

Show GetRefundsResponseBody200Object'

Defined in StripeAPI.Operations.GetRefunds

Methods

showsPrec :: Int -> GetRefundsResponseBody200Object' -> ShowS

show :: GetRefundsResponseBody200Object' -> String

showList :: [GetRefundsResponseBody200Object'] -> ShowS

ToJSON GetRefundsResponseBody200Object'

Defined in StripeAPI.Operations.GetRefunds

Methods

toJSON :: GetRefundsResponseBody200Object' -> Value

toEncoding :: GetRefundsResponseBody200Object' -> Encoding

toJSONList :: [GetRefundsResponseBody200Object'] -> Value

toEncodingList :: [GetRefundsResponseBody200Object'] -> Encoding

FromJSON GetRefundsResponseBody200Object'

Defined in StripeAPI.Operations.GetRefunds

Methods

parseJSON :: Value -> Parser GetRefundsResponseBody200Object'

parseJSONList :: Value -> Parser [GetRefundsResponseBody200Object']