| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetInvoices
Description
Contains the different functions to run the operation getInvoices
Synopsis
- getInvoices :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetInvoicesRequestBody -> m (Either HttpException (Response GetInvoicesResponse))
- getInvoicesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetInvoicesRequestBody -> m (Either HttpException (Response ByteString))
- getInvoicesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetInvoicesResponse))
- getInvoicesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetInvoicesRequestBody = GetInvoicesRequestBody {
- data GetInvoicesResponse
- data GetInvoicesResponseBody200 = GetInvoicesResponseBody200 {}
- data GetInvoicesResponseBody200Object'
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | collection_method: The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. | Constraints: Maximum length of 5000 |
| -> Maybe String | created |
| -> Maybe String | customer: Only return invoices for the customer specified by this customer ID. | Constraints: Maximum length of 5000 |
| -> Maybe String | due_date |
| -> Maybe String | 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 |
| -> Maybe String | 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 String | 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 |
| -> Maybe String | status: The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. Learn more | Constraints: Maximum length of 5000 |
| -> Maybe String | subscription: Only return invoices for the subscription specified by this subscription ID. | Constraints: Maximum length of 5000 |
| -> GetInvoicesRequestBody | The request body to send |
| -> m (Either HttpException (Response GetInvoicesResponse)) | Monad containing 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>
getInvoicesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetInvoicesRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/invoices
The same as getInvoices but returns the raw ByteString
getInvoicesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetInvoicesResponse)) Source #
GET /v1/invoices
Monadic version of getInvoices (use with runWithConfiguration)
getInvoicesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/invoices
Monadic version of getInvoicesRaw (use with runWithConfiguration)
data GetInvoicesRequestBody Source #
Defines the data type for the schema getInvoicesRequestBody
Constructors
| GetInvoicesRequestBody | |
Instances
| Eq GetInvoicesRequestBody Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods (==) :: GetInvoicesRequestBody -> GetInvoicesRequestBody -> Bool # (/=) :: GetInvoicesRequestBody -> GetInvoicesRequestBody -> Bool # | |
| Show GetInvoicesRequestBody Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods showsPrec :: Int -> GetInvoicesRequestBody -> ShowS # show :: GetInvoicesRequestBody -> String # showList :: [GetInvoicesRequestBody] -> ShowS # | |
| ToJSON GetInvoicesRequestBody Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods toJSON :: GetInvoicesRequestBody -> Value # toEncoding :: GetInvoicesRequestBody -> Encoding # toJSONList :: [GetInvoicesRequestBody] -> Value # | |
| FromJSON GetInvoicesRequestBody Source # | |
Defined in StripeAPI.Operations.GetInvoices Methods parseJSON :: Value -> Parser GetInvoicesRequestBody # parseJSONList :: Value -> Parser [GetInvoicesRequestBody] # | |
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 data type for the schema GetInvoicesResponseBody200
Constructors
| GetInvoicesResponseBody200 | |
Fields
| |
Instances
data GetInvoicesResponseBody200Object' Source #
Defines the enum schema GetInvoicesResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetInvoicesResponseBody200Object'EnumOther Value | |
| GetInvoicesResponseBody200Object'EnumTyped String | |
| GetInvoicesResponseBody200Object'EnumStringList |