Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetRefunds

Contains the different functions to run the operation getRefunds

Synopsis

value getRefunds
data GetRefundsParameters
value mkGetRefundsParameters
data GetRefundsParametersQueryCreated'OneOf1
value mkGetRefundsParametersQueryCreated'OneOf1
data GetRefundsParametersQueryCreated'Variants
data GetRefundsResponse
data GetRefundsResponseBody200
value mkGetRefundsResponseBody200

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetRefunds.hs

valuegetRefunds

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

datadata GetRefundsParameters

Source#

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRefundsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
Show GetRefundsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
FromJSON GetRefundsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
ToJSON GetRefundsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds

valuemkGetRefundsParameters :: GetRefundsParameters

Source#

Create a new GetRefundsParameters with all required fields.

datadata GetRefundsParametersQueryCreated'OneOf1

Source#

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

Constructors

GetRefundsParametersQueryCreated'OneOf1
- getRefundsParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getRefundsParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getRefundsParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getRefundsParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRefundsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
Show GetRefundsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
FromJSON GetRefundsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
ToJSON GetRefundsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds

valuemkGetRefundsParametersQueryCreated'OneOf1 :: GetRefundsParametersQueryCreated'OneOf1

Source#

Create a new GetRefundsParametersQueryCreated'OneOf1 with all required fields.

datadata GetRefundsParametersQueryCreated'Variants

Source#

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRefundsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
Show GetRefundsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
FromJSON GetRefundsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
ToJSON GetRefundsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds

datadata GetRefundsResponse

Source#

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.

Instances2Eq, Show

Eq GetRefundsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
Show GetRefundsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds

datadata GetRefundsResponseBody200

Source#

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRefundsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
Show GetRefundsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
FromJSON GetRefundsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds
ToJSON GetRefundsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRefunds

valuemkGetRefundsResponseBody200

:: [Refund]
getRefundsResponseBody200Data
-> Bool
getRefundsResponseBody200HasMore
-> Text
getRefundsResponseBody200Url
-> GetRefundsResponseBody200

Source#

Create a new GetRefundsResponseBody200 with all required fields.