StripeAPI.Operations.GetApplicationFeesIdRefunds

Contains the different functions to run the operation getApplicationFeesIdRefunds

Documentation

getApplicationFeesIdRefunds

Arguments

:: forall m. MonadHTTP m

=> GetApplicationFeesIdRefundsParameters

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

-> ClientT m (Response GetApplicationFeesIdRefundsResponse)

Monadic computation which returns the result of the operation

GET /v1/application_fees/{id}/refunds

<p>You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee 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 GetApplicationFeesIdRefundsParameters

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

Constructors

GetApplicationFeesIdRefundsParameters

Fields

• getApplicationFeesIdRefundsParametersPathId :: Text

  pathId: Represents the parameter named 'id'

  Constraints:

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

  Constraints:

  • Maximum length of 5000
• getApplicationFeesIdRefundsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

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

  Constraints:

  • Maximum length of 5000

Instances

Eq GetApplicationFeesIdRefundsParameters

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

(==) :: GetApplicationFeesIdRefundsParameters -> GetApplicationFeesIdRefundsParameters -> Bool

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

Show GetApplicationFeesIdRefundsParameters

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

showsPrec :: Int -> GetApplicationFeesIdRefundsParameters -> ShowS

show :: GetApplicationFeesIdRefundsParameters -> String

showList :: [GetApplicationFeesIdRefundsParameters] -> ShowS

ToJSON GetApplicationFeesIdRefundsParameters

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

toJSON :: GetApplicationFeesIdRefundsParameters -> Value

toEncoding :: GetApplicationFeesIdRefundsParameters -> Encoding

toJSONList :: [GetApplicationFeesIdRefundsParameters] -> Value

toEncodingList :: [GetApplicationFeesIdRefundsParameters] -> Encoding

FromJSON GetApplicationFeesIdRefundsParameters

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

parseJSON :: Value -> Parser GetApplicationFeesIdRefundsParameters

parseJSONList :: Value -> Parser [GetApplicationFeesIdRefundsParameters]

mkGetApplicationFeesIdRefundsParameters

Arguments

:: Text

getApplicationFeesIdRefundsParametersPathId

-> GetApplicationFeesIdRefundsParameters

Create a new GetApplicationFeesIdRefundsParameters with all required fields.

data GetApplicationFeesIdRefundsResponse

Represents a response of the operation getApplicationFeesIdRefunds.

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

Constructors

GetApplicationFeesIdRefundsResponseError String

Means either no matching case available or a parse error

GetApplicationFeesIdRefundsResponse200 GetApplicationFeesIdRefundsResponseBody200

Successful response.

GetApplicationFeesIdRefundsResponseDefault Error

Error response.

Instances

Eq GetApplicationFeesIdRefundsResponse

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

(==) :: GetApplicationFeesIdRefundsResponse -> GetApplicationFeesIdRefundsResponse -> Bool

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

Show GetApplicationFeesIdRefundsResponse

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

showsPrec :: Int -> GetApplicationFeesIdRefundsResponse -> ShowS

show :: GetApplicationFeesIdRefundsResponse -> String

showList :: [GetApplicationFeesIdRefundsResponse] -> ShowS

data GetApplicationFeesIdRefundsResponseBody200

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

Constructors

GetApplicationFeesIdRefundsResponseBody200

Fields

• getApplicationFeesIdRefundsResponseBody200Data :: [FeeRefund]

  data: Details about each object.

• getApplicationFeesIdRefundsResponseBody200HasMore :: Bool

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

• getApplicationFeesIdRefundsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetApplicationFeesIdRefundsResponseBody200

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

(==) :: GetApplicationFeesIdRefundsResponseBody200 -> GetApplicationFeesIdRefundsResponseBody200 -> Bool

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

Show GetApplicationFeesIdRefundsResponseBody200

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

showsPrec :: Int -> GetApplicationFeesIdRefundsResponseBody200 -> ShowS

show :: GetApplicationFeesIdRefundsResponseBody200 -> String

showList :: [GetApplicationFeesIdRefundsResponseBody200] -> ShowS

ToJSON GetApplicationFeesIdRefundsResponseBody200

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

toJSON :: GetApplicationFeesIdRefundsResponseBody200 -> Value

toEncoding :: GetApplicationFeesIdRefundsResponseBody200 -> Encoding

toJSONList :: [GetApplicationFeesIdRefundsResponseBody200] -> Value

toEncodingList :: [GetApplicationFeesIdRefundsResponseBody200] -> Encoding

FromJSON GetApplicationFeesIdRefundsResponseBody200

Defined in StripeAPI.Operations.GetApplicationFeesIdRefunds

Methods

parseJSON :: Value -> Parser GetApplicationFeesIdRefundsResponseBody200

parseJSONList :: Value -> Parser [GetApplicationFeesIdRefundsResponseBody200]

mkGetApplicationFeesIdRefundsResponseBody200

Arguments

:: [FeeRefund]

getApplicationFeesIdRefundsResponseBody200Data

-> Bool

getApplicationFeesIdRefundsResponseBody200HasMore

-> Text

getApplicationFeesIdRefundsResponseBody200Url

-> GetApplicationFeesIdRefundsResponseBody200

Create a new GetApplicationFeesIdRefundsResponseBody200 with all required fields.