Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetCharges

Contains the different functions to run the operation getCharges

Synopsis

value getCharges
data GetChargesParameters
value mkGetChargesParameters
data GetChargesParametersQueryCreated'OneOf1
value mkGetChargesParametersQueryCreated'OneOf1
data GetChargesParametersQueryCreated'Variants
data GetChargesResponse
data GetChargesResponseBody200
value mkGetChargesResponseBody200

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetCharges.hs

valuegetCharges

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

datadata GetChargesParameters

Source#

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetChargesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
Show GetChargesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
FromJSON GetChargesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
ToJSON GetChargesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges

valuemkGetChargesParameters :: GetChargesParameters

Source#

Create a new GetChargesParameters with all required fields.

datadata GetChargesParametersQueryCreated'OneOf1

Source#

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

Constructors

GetChargesParametersQueryCreated'OneOf1
- getChargesParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getChargesParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getChargesParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getChargesParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetChargesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
Show GetChargesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
FromJSON GetChargesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
ToJSON GetChargesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges

valuemkGetChargesParametersQueryCreated'OneOf1 :: GetChargesParametersQueryCreated'OneOf1

Source#

Create a new GetChargesParametersQueryCreated'OneOf1 with all required fields.

datadata GetChargesParametersQueryCreated'Variants

Source#

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetChargesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
Show GetChargesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
FromJSON GetChargesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
ToJSON GetChargesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges

datadata GetChargesResponse

Source#

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.

Instances2Eq, Show

Eq GetChargesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
Show GetChargesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges

datadata GetChargesResponseBody200

Source#

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetChargesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
Show GetChargesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
FromJSON GetChargesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges
ToJSON GetChargesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCharges

valuemkGetChargesResponseBody200

:: [Charge]
getChargesResponseBody200Data
-> Bool
getChargesResponseBody200HasMore
-> Text
getChargesResponseBody200Url
-> GetChargesResponseBody200

Source#

Create a new GetChargesResponseBody200 with all required fields.