Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetChargesChargeRefunds

Contains the different functions to run the operation getChargesChargeRefunds

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetChargesChargeRefunds.hs

valuegetChargesChargeRefunds

:: MonadHTTP m
=> GetChargesChargeRefundsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT 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>

datadata GetChargesChargeRefundsParameters

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetChargesChargeRefundsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds
Show GetChargesChargeRefundsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds
FromJSON GetChargesChargeRefundsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds
ToJSON GetChargesChargeRefundsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds

valuemkGetChargesChargeRefundsParameters

:: Text
getChargesChargeRefundsParametersPathCharge
-> GetChargesChargeRefundsParameters

Create a new GetChargesChargeRefundsParameters with all required fields.

datadata GetChargesChargeRefundsResponse

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.

Instances2Eq, Show

Eq GetChargesChargeRefundsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds
Show GetChargesChargeRefundsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds

datadata GetChargesChargeRefundsResponseBody200

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetChargesChargeRefundsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds
Show GetChargesChargeRefundsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds
FromJSON GetChargesChargeRefundsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds
ToJSON GetChargesChargeRefundsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetChargesChargeRefunds

valuemkGetChargesChargeRefundsResponseBody200

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

Create a new GetChargesChargeRefundsResponseBody200 with all required fields.