StripeAPI.Operations.GetCharges

Contains the different functions to run the operation getCharges

Documentation

getCharges

Arguments

:: forall m. MonadHTTP m

=> GetChargesParameters

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

-> ClientT m (Response GetChargesResponse)

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

data GetChargesParameters

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

Constructors

GetChargesParameters

Fields

• getChargesParametersQueryCreated :: Maybe GetChargesParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

• getChargesParametersQueryCustomer :: Maybe Text

  queryCustomer: Represents the parameter named 'customer'

  Only return charges for the customer specified by this customer ID.

  Constraints:

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

• getChargesParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

• getChargesParametersQueryPaymentIntent :: Maybe Text

  queryPayment_intent: Represents the parameter named 'payment_intent'

  Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.

  Constraints:

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

• getChargesParametersQueryTransferGroup :: Maybe Text

  queryTransfer_group: Represents the parameter named 'transfer_group'

  Only return charges for this transfer group.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetChargesParameters

Defined in StripeAPI.Operations.GetCharges

Methods

(==) :: GetChargesParameters -> GetChargesParameters -> Bool

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

Show GetChargesParameters

Defined in StripeAPI.Operations.GetCharges

Methods

showsPrec :: Int -> GetChargesParameters -> ShowS

show :: GetChargesParameters -> String

showList :: [GetChargesParameters] -> ShowS

ToJSON GetChargesParameters

Defined in StripeAPI.Operations.GetCharges

Methods

toJSON :: GetChargesParameters -> Value

toEncoding :: GetChargesParameters -> Encoding

toJSONList :: [GetChargesParameters] -> Value

toEncodingList :: [GetChargesParameters] -> Encoding

FromJSON GetChargesParameters

Defined in StripeAPI.Operations.GetCharges

Methods

parseJSON :: Value -> Parser GetChargesParameters

parseJSONList :: Value -> Parser [GetChargesParameters]

mkGetChargesParameters :: GetChargesParameters

Create a new GetChargesParameters with all required fields.

data GetChargesParametersQueryCreated'OneOf1

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

Constructors

GetChargesParametersQueryCreated'OneOf1

Fields

• getChargesParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getChargesParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getChargesParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getChargesParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetChargesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCharges

Methods

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

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

Show GetChargesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCharges

Methods

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

show :: GetChargesParametersQueryCreated'OneOf1 -> String

showList :: [GetChargesParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetChargesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCharges

Methods

toJSON :: GetChargesParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetChargesParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetChargesParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetChargesParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetChargesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCharges

Methods

parseJSON :: Value -> Parser GetChargesParametersQueryCreated'OneOf1

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

mkGetChargesParametersQueryCreated'OneOf1 :: GetChargesParametersQueryCreated'OneOf1

Create a new GetChargesParametersQueryCreated'OneOf1 with all required fields.

data GetChargesParametersQueryCreated'Variants

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

Represents the parameter named 'created'

Constructors

GetChargesParametersQueryCreated'GetChargesParametersQueryCreated'OneOf1 GetChargesParametersQueryCreated'OneOf1

GetChargesParametersQueryCreated'Int Int

Instances

Eq GetChargesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCharges

Methods

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

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

Show GetChargesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCharges

Methods

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

show :: GetChargesParametersQueryCreated'Variants -> String

showList :: [GetChargesParametersQueryCreated'Variants] -> ShowS

ToJSON GetChargesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCharges

Methods

toJSON :: GetChargesParametersQueryCreated'Variants -> Value

toEncoding :: GetChargesParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetChargesParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetChargesParametersQueryCreated'Variants] -> Encoding

FromJSON GetChargesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCharges

Methods

parseJSON :: Value -> Parser GetChargesParametersQueryCreated'Variants

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

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

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.

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

mkGetChargesResponseBody200

Arguments

:: [Charge]

getChargesResponseBody200Data

-> Bool

getChargesResponseBody200HasMore

-> Text

getChargesResponseBody200Url

-> GetChargesResponseBody200

Create a new GetChargesResponseBody200 with all required fields.