StripeAPI.Operations.GetCharges

Contains the different functions to run the operation getCharges

Documentation

getCharges

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

created

-> Maybe Text

customer: Only return charges for the customer specified by this customer ID. | Constraints: Maximum length of 5000

-> 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 charges that were created by the PaymentIntent specified by this PaymentIntent 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 Text

transfer_group: Only return charges for this transfer group. | Constraints: Maximum length of 5000

-> Maybe GetChargesRequestBody

The request body to send

-> m (Either HttpException (Response GetChargesResponse))

Monad containing the result of the operation

GET /v1/charges

<p>Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.</p>

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

GET /v1/charges

The same as getCharges but returns the raw ByteString

getChargesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetChargesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetChargesResponse))

GET /v1/charges

Monadic version of getCharges (use with runWithConfiguration)

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

GET /v1/charges

Monadic version of getChargesRaw (use with runWithConfiguration)

data GetChargesRequestBody

Defines the data type for the schema getChargesRequestBody

Constructors

GetChargesRequestBody

Instances

Eq GetChargesRequestBody

Defined in StripeAPI.Operations.GetCharges

Methods

(==) :: GetChargesRequestBody -> GetChargesRequestBody -> Bool

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

Show GetChargesRequestBody

Defined in StripeAPI.Operations.GetCharges

Methods

showsPrec :: Int -> GetChargesRequestBody -> ShowS

show :: GetChargesRequestBody -> String

showList :: [GetChargesRequestBody] -> ShowS

ToJSON GetChargesRequestBody

Defined in StripeAPI.Operations.GetCharges

Methods

toJSON :: GetChargesRequestBody -> Value

toEncoding :: GetChargesRequestBody -> Encoding

toJSONList :: [GetChargesRequestBody] -> Value

toEncodingList :: [GetChargesRequestBody] -> Encoding

FromJSON GetChargesRequestBody

Defined in StripeAPI.Operations.GetCharges

Methods

parseJSON :: Value -> Parser GetChargesRequestBody

parseJSONList :: Value -> Parser [GetChargesRequestBody]

data GetChargesResponse

Represents a response of the operation getCharges.

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

Constructors

GetChargesResponseError String

Means either no matching case available or a parse error

GetChargesResponse200 GetChargesResponseBody200

Successful response.

GetChargesResponseDefault Error

Error response.

Instances

Eq GetChargesResponse

Defined in StripeAPI.Operations.GetCharges

Methods

(==) :: GetChargesResponse -> GetChargesResponse -> Bool

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

Show GetChargesResponse

Defined in StripeAPI.Operations.GetCharges

Methods

showsPrec :: Int -> GetChargesResponse -> ShowS

show :: GetChargesResponse -> String

showList :: [GetChargesResponse] -> ShowS

data GetChargesResponseBody200

Defines the data type for the schema GetChargesResponseBody200

Constructors

GetChargesResponseBody200

Fields

• getChargesResponseBody200Data :: [] Charge

  data

• getChargesResponseBody200HasMore :: Bool

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

• getChargesResponseBody200Object :: GetChargesResponseBody200Object'

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

• getChargesResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetChargesResponseBody200

Defined in StripeAPI.Operations.GetCharges

Methods

(==) :: GetChargesResponseBody200 -> GetChargesResponseBody200 -> Bool

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

Show GetChargesResponseBody200

Defined in StripeAPI.Operations.GetCharges

Methods

showsPrec :: Int -> GetChargesResponseBody200 -> ShowS

show :: GetChargesResponseBody200 -> String

showList :: [GetChargesResponseBody200] -> ShowS

ToJSON GetChargesResponseBody200

Defined in StripeAPI.Operations.GetCharges

Methods

toJSON :: GetChargesResponseBody200 -> Value

toEncoding :: GetChargesResponseBody200 -> Encoding

toJSONList :: [GetChargesResponseBody200] -> Value

toEncodingList :: [GetChargesResponseBody200] -> Encoding

FromJSON GetChargesResponseBody200

Defined in StripeAPI.Operations.GetCharges

Methods

parseJSON :: Value -> Parser GetChargesResponseBody200

parseJSONList :: Value -> Parser [GetChargesResponseBody200]

data GetChargesResponseBody200Object'

Defines the enum schema GetChargesResponseBody200Object'

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

Constructors

GetChargesResponseBody200Object'EnumOther Value

GetChargesResponseBody200Object'EnumTyped Text

GetChargesResponseBody200Object'EnumStringList

Instances

Eq GetChargesResponseBody200Object'

Defined in StripeAPI.Operations.GetCharges

Methods

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

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

Show GetChargesResponseBody200Object'

Defined in StripeAPI.Operations.GetCharges

Methods

showsPrec :: Int -> GetChargesResponseBody200Object' -> ShowS

show :: GetChargesResponseBody200Object' -> String

showList :: [GetChargesResponseBody200Object'] -> ShowS

ToJSON GetChargesResponseBody200Object'

Defined in StripeAPI.Operations.GetCharges

Methods

toJSON :: GetChargesResponseBody200Object' -> Value

toEncoding :: GetChargesResponseBody200Object' -> Encoding

toJSONList :: [GetChargesResponseBody200Object'] -> Value

toEncodingList :: [GetChargesResponseBody200Object'] -> Encoding

FromJSON GetChargesResponseBody200Object'

Defined in StripeAPI.Operations.GetCharges

Methods

parseJSON :: Value -> Parser GetChargesResponseBody200Object'

parseJSONList :: Value -> Parser [GetChargesResponseBody200Object']