| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetInvoices
Description
Contains the different functions to run the operation getInvoices
Synopsis
- getInvoices :: forall m. MonadHTTP m => GetInvoicesParameters -> ClientT m (Response GetInvoicesResponse)
- data GetInvoicesParameters = GetInvoicesParameters {
- getInvoicesParametersQueryCollectionMethod :: Maybe GetInvoicesParametersQueryCollectionMethod'
- getInvoicesParametersQueryCreated :: Maybe GetInvoicesParametersQueryCreated'Variants
- getInvoicesParametersQueryCustomer :: Maybe Text
- getInvoicesParametersQueryDueDate :: Maybe GetInvoicesParametersQueryDueDate'Variants
- getInvoicesParametersQueryEndingBefore :: Maybe Text
- getInvoicesParametersQueryExpand :: Maybe [Text]
- getInvoicesParametersQueryLimit :: Maybe Int
- getInvoicesParametersQueryStartingAfter :: Maybe Text
- getInvoicesParametersQueryStatus :: Maybe GetInvoicesParametersQueryStatus'
- getInvoicesParametersQuerySubscription :: Maybe Text
- mkGetInvoicesParameters :: GetInvoicesParameters
- data GetInvoicesParametersQueryCollectionMethod'
- data GetInvoicesParametersQueryCreated'OneOf1 = GetInvoicesParametersQueryCreated'OneOf1 {}
- mkGetInvoicesParametersQueryCreated'OneOf1 :: GetInvoicesParametersQueryCreated'OneOf1
- data GetInvoicesParametersQueryCreated'Variants
- data GetInvoicesParametersQueryDueDate'OneOf1 = GetInvoicesParametersQueryDueDate'OneOf1 {}
- mkGetInvoicesParametersQueryDueDate'OneOf1 :: GetInvoicesParametersQueryDueDate'OneOf1
- data GetInvoicesParametersQueryDueDate'Variants
- data GetInvoicesParametersQueryStatus'
- = GetInvoicesParametersQueryStatus'Other Value
- | GetInvoicesParametersQueryStatus'Typed Text
- | GetInvoicesParametersQueryStatus'EnumDraft
- | GetInvoicesParametersQueryStatus'EnumOpen
- | GetInvoicesParametersQueryStatus'EnumPaid
- | GetInvoicesParametersQueryStatus'EnumUncollectible
- | GetInvoicesParametersQueryStatus'EnumVoid
- data GetInvoicesResponse
- data GetInvoicesResponseBody200 = GetInvoicesResponseBody200 {}
- mkGetInvoicesResponseBody200 :: [Invoice] -> Bool -> Text -> GetInvoicesResponseBody200
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => GetInvoicesParameters | Contains all available parameters of this operation (query and path parameters) |
| -> ClientT m (Response GetInvoicesResponse) | Monadic computation which returns the result of the operation |
GET /v1/invoices
<p>You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.</p>
data GetInvoicesParameters Source #
Defines the object schema located at paths./v1/invoices.GET.parameters in the specification.
Constructors
| GetInvoicesParameters | |
Fields
| |
Instances
| Eq GetInvoicesParameters Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods (==) :: GetInvoicesParameters -> GetInvoicesParameters -> Bool # (/=) :: GetInvoicesParameters -> GetInvoicesParameters -> Bool # | |
| Show GetInvoicesParameters Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods showsPrec :: Int -> GetInvoicesParameters -> ShowS # show :: GetInvoicesParameters -> String # showList :: [GetInvoicesParameters] -> ShowS # | |
| ToJSON GetInvoicesParameters Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods toJSON :: GetInvoicesParameters -> Value # toEncoding :: GetInvoicesParameters -> Encoding # toJSONList :: [GetInvoicesParameters] -> Value # toEncodingList :: [GetInvoicesParameters] -> Encoding # | |
| FromJSON GetInvoicesParameters Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods parseJSON :: Value -> Parser GetInvoicesParameters # parseJSONList :: Value -> Parser [GetInvoicesParameters] # | |
mkGetInvoicesParameters :: GetInvoicesParameters Source #
Create a new GetInvoicesParameters with all required fields.
data GetInvoicesParametersQueryCollectionMethod' Source #
Defines the enum schema located at paths./v1/invoices.GET.parameters.properties.queryCollection_method in the specification.
Represents the parameter named 'collection_method'
The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
Constructors
| GetInvoicesParametersQueryCollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| GetInvoicesParametersQueryCollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| GetInvoicesParametersQueryCollectionMethod'EnumChargeAutomatically | Represents the JSON value |
| GetInvoicesParametersQueryCollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
data GetInvoicesParametersQueryCreated'OneOf1 Source #
Defines the object schema located at paths./v1/invoices.GET.parameters.properties.queryCreated.anyOf in the specification.
Constructors
| GetInvoicesParametersQueryCreated'OneOf1 | |
Instances
mkGetInvoicesParametersQueryCreated'OneOf1 :: GetInvoicesParametersQueryCreated'OneOf1 Source #
Create a new GetInvoicesParametersQueryCreated'OneOf1 with all required fields.
data GetInvoicesParametersQueryCreated'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.GET.parameters.properties.queryCreated.anyOf in the specification.
Represents the parameter named 'created'
Constructors
| GetInvoicesParametersQueryCreated'GetInvoicesParametersQueryCreated'OneOf1 GetInvoicesParametersQueryCreated'OneOf1 | |
| GetInvoicesParametersQueryCreated'Int Int |
Instances
data GetInvoicesParametersQueryDueDate'OneOf1 Source #
Defines the object schema located at paths./v1/invoices.GET.parameters.properties.queryDue_date.anyOf in the specification.
Constructors
| GetInvoicesParametersQueryDueDate'OneOf1 | |
Instances
mkGetInvoicesParametersQueryDueDate'OneOf1 :: GetInvoicesParametersQueryDueDate'OneOf1 Source #
Create a new GetInvoicesParametersQueryDueDate'OneOf1 with all required fields.
data GetInvoicesParametersQueryDueDate'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.GET.parameters.properties.queryDue_date.anyOf in the specification.
Represents the parameter named 'due_date'
Constructors
| GetInvoicesParametersQueryDueDate'GetInvoicesParametersQueryDueDate'OneOf1 GetInvoicesParametersQueryDueDate'OneOf1 | |
| GetInvoicesParametersQueryDueDate'Int Int |
Instances
data GetInvoicesParametersQueryStatus' Source #
Defines the enum schema located at paths./v1/invoices.GET.parameters.properties.queryStatus in the specification.
Represents the parameter named 'status'
The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. Learn more
Constructors
| GetInvoicesParametersQueryStatus'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| GetInvoicesParametersQueryStatus'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| GetInvoicesParametersQueryStatus'EnumDraft | Represents the JSON value |
| GetInvoicesParametersQueryStatus'EnumOpen | Represents the JSON value |
| GetInvoicesParametersQueryStatus'EnumPaid | Represents the JSON value |
| GetInvoicesParametersQueryStatus'EnumUncollectible | Represents the JSON value |
| GetInvoicesParametersQueryStatus'EnumVoid | Represents the JSON value |
Instances
data GetInvoicesResponse Source #
Represents a response of the operation getInvoices.
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), GetInvoicesResponseError is used.
Constructors
| GetInvoicesResponseError String | Means either no matching case available or a parse error |
| GetInvoicesResponse200 GetInvoicesResponseBody200 | Successful response. |
| GetInvoicesResponseDefault Error | Error response. |
Instances
| Eq GetInvoicesResponse Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods (==) :: GetInvoicesResponse -> GetInvoicesResponse -> Bool # (/=) :: GetInvoicesResponse -> GetInvoicesResponse -> Bool # | |
| Show GetInvoicesResponse Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods showsPrec :: Int -> GetInvoicesResponse -> ShowS # show :: GetInvoicesResponse -> String # showList :: [GetInvoicesResponse] -> ShowS # | |
data GetInvoicesResponseBody200 Source #
Defines the object schema located at paths./v1/invoices.GET.responses.200.content.application/json.schema in the specification.
Constructors
| GetInvoicesResponseBody200 | |
Fields
| |
Instances
mkGetInvoicesResponseBody200 Source #
Arguments
| :: [Invoice] | |
| -> Bool | |
| -> Text | |
| -> GetInvoicesResponseBody200 |
Create a new GetInvoicesResponseBody200 with all required fields.