StripeAPI.Operations.GetRefunds

Contains the different functions to run the operation getRefunds

Documentation

getRefunds

Arguments

:: forall m. MonadHTTP m

=> GetRefundsParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetRefundsResponse)

Monadic computation which returns 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>

data GetRefundsParameters

Defines the object schema located at paths./v1/refunds.GET.parameters in the specification.

Constructors

GetRefundsParameters

Fields

• getRefundsParametersQueryCharge :: Maybe Text

  queryCharge: Represents the parameter named 'charge'

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

• getRefundsParametersQueryCreated :: Maybe GetRefundsParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

• getRefundsParametersQueryEndingBefore :: 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.

• getRefundsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getRefundsParametersQueryLimit :: 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.

• getRefundsParametersQueryPaymentIntent :: Maybe Text

  queryPayment_intent: Represents the parameter named 'payment_intent'

  Only return refunds for the PaymentIntent specified by this ID.

  Constraints:

  • Maximum length of 5000
• getRefundsParametersQueryStartingAfter :: 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

Eq GetRefundsParameters

Defined in StripeAPI.Operations.GetRefunds

Methods

(==) :: GetRefundsParameters -> GetRefundsParameters -> Bool

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

Show GetRefundsParameters

Defined in StripeAPI.Operations.GetRefunds

Methods

showsPrec :: Int -> GetRefundsParameters -> ShowS

show :: GetRefundsParameters -> String

showList :: [GetRefundsParameters] -> ShowS

ToJSON GetRefundsParameters

Defined in StripeAPI.Operations.GetRefunds

Methods

toJSON :: GetRefundsParameters -> Value

toEncoding :: GetRefundsParameters -> Encoding

toJSONList :: [GetRefundsParameters] -> Value

toEncodingList :: [GetRefundsParameters] -> Encoding

FromJSON GetRefundsParameters

Defined in StripeAPI.Operations.GetRefunds

Methods

parseJSON :: Value -> Parser GetRefundsParameters

parseJSONList :: Value -> Parser [GetRefundsParameters]

mkGetRefundsParameters :: GetRefundsParameters

Create a new GetRefundsParameters with all required fields.

data GetRefundsParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/refunds.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetRefundsParametersQueryCreated'OneOf1

Fields

• getRefundsParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getRefundsParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getRefundsParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getRefundsParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetRefundsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetRefunds

Methods

(==) :: GetRefundsParametersQueryCreated'OneOf1 -> GetRefundsParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetRefundsParametersQueryCreated'OneOf1 -> GetRefundsParametersQueryCreated'OneOf1 -> Bool

Show GetRefundsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetRefunds

Methods

showsPrec :: Int -> GetRefundsParametersQueryCreated'OneOf1 -> ShowS

show :: GetRefundsParametersQueryCreated'OneOf1 -> String

showList :: [GetRefundsParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetRefundsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetRefunds

Methods

toJSON :: GetRefundsParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetRefundsParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetRefundsParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetRefundsParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetRefundsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetRefunds

Methods

parseJSON :: Value -> Parser GetRefundsParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetRefundsParametersQueryCreated'OneOf1]

mkGetRefundsParametersQueryCreated'OneOf1 :: GetRefundsParametersQueryCreated'OneOf1

Create a new GetRefundsParametersQueryCreated'OneOf1 with all required fields.

data GetRefundsParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/refunds.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetRefundsParametersQueryCreated'GetRefundsParametersQueryCreated'OneOf1 GetRefundsParametersQueryCreated'OneOf1

GetRefundsParametersQueryCreated'Int Int

Instances

Eq GetRefundsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetRefunds

Methods

(==) :: GetRefundsParametersQueryCreated'Variants -> GetRefundsParametersQueryCreated'Variants -> Bool

(/=) :: GetRefundsParametersQueryCreated'Variants -> GetRefundsParametersQueryCreated'Variants -> Bool

Show GetRefundsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetRefunds

Methods

showsPrec :: Int -> GetRefundsParametersQueryCreated'Variants -> ShowS

show :: GetRefundsParametersQueryCreated'Variants -> String

showList :: [GetRefundsParametersQueryCreated'Variants] -> ShowS

ToJSON GetRefundsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetRefunds

Methods

toJSON :: GetRefundsParametersQueryCreated'Variants -> Value

toEncoding :: GetRefundsParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetRefundsParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetRefundsParametersQueryCreated'Variants] -> Encoding

FromJSON GetRefundsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetRefunds

Methods

parseJSON :: Value -> Parser GetRefundsParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetRefundsParametersQueryCreated'Variants]

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 object schema located at paths./v1/refunds.GET.responses.200.content.application/json.schema in the specification.

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.

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

mkGetRefundsResponseBody200

Arguments

:: [Refund]

getRefundsResponseBody200Data

-> Bool

getRefundsResponseBody200HasMore

-> Text

getRefundsResponseBody200Url

-> GetRefundsResponseBody200

Create a new GetRefundsResponseBody200 with all required fields.