StripeAPI.Operations.GetInvoices

Contains the different functions to run the operation getInvoices

Documentation

getInvoices

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

collection_method: The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. | Constraints: Maximum length of 5000

-> Maybe Text

created

-> Maybe Text

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

-> Maybe Text

due_date

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

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

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 Text

status: The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. Learn more | Constraints: Maximum length of 5000

-> Maybe Text

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

-> Maybe 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 Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetInvoicesRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/invoices

The same as getInvoices but returns the raw ByteString

getInvoicesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetInvoicesResponse))

GET /v1/invoices

Monadic version of getInvoices (use with runWithConfiguration)

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

GET /v1/invoices

Monadic version of getInvoicesRaw (use with runWithConfiguration)

data GetInvoicesRequestBody

Defines the data type for the schema getInvoicesRequestBody

Constructors

GetInvoicesRequestBody

Instances

Eq GetInvoicesRequestBody

Defined in StripeAPI.Operations.GetInvoices

Methods

(==) :: GetInvoicesRequestBody -> GetInvoicesRequestBody -> Bool

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

Show GetInvoicesRequestBody

Defined in StripeAPI.Operations.GetInvoices

Methods

showsPrec :: Int -> GetInvoicesRequestBody -> ShowS

show :: GetInvoicesRequestBody -> String

showList :: [GetInvoicesRequestBody] -> ShowS

ToJSON GetInvoicesRequestBody

Defined in StripeAPI.Operations.GetInvoices

Methods

toJSON :: GetInvoicesRequestBody -> Value

toEncoding :: GetInvoicesRequestBody -> Encoding

toJSONList :: [GetInvoicesRequestBody] -> Value

toEncodingList :: [GetInvoicesRequestBody] -> Encoding

FromJSON GetInvoicesRequestBody

Defined in StripeAPI.Operations.GetInvoices

Methods

parseJSON :: Value -> Parser GetInvoicesRequestBody

parseJSONList :: Value -> Parser [GetInvoicesRequestBody]

data GetInvoicesResponse

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

Defined in StripeAPI.Operations.GetInvoices

Methods

(==) :: GetInvoicesResponse -> GetInvoicesResponse -> Bool

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

Show GetInvoicesResponse

Defined in StripeAPI.Operations.GetInvoices

Methods

showsPrec :: Int -> GetInvoicesResponse -> ShowS

show :: GetInvoicesResponse -> String

showList :: [GetInvoicesResponse] -> ShowS

data GetInvoicesResponseBody200

Defines the data type for the schema GetInvoicesResponseBody200

Constructors

GetInvoicesResponseBody200

Fields

• getInvoicesResponseBody200Data :: [] Invoice

  data

• getInvoicesResponseBody200HasMore :: Bool

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

• getInvoicesResponseBody200Object :: GetInvoicesResponseBody200Object'

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

• getInvoicesResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetInvoicesResponseBody200

Defined in StripeAPI.Operations.GetInvoices

Methods

(==) :: GetInvoicesResponseBody200 -> GetInvoicesResponseBody200 -> Bool

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

Show GetInvoicesResponseBody200

Defined in StripeAPI.Operations.GetInvoices

Methods

showsPrec :: Int -> GetInvoicesResponseBody200 -> ShowS

show :: GetInvoicesResponseBody200 -> String

showList :: [GetInvoicesResponseBody200] -> ShowS

ToJSON GetInvoicesResponseBody200

Defined in StripeAPI.Operations.GetInvoices

Methods

toJSON :: GetInvoicesResponseBody200 -> Value

toEncoding :: GetInvoicesResponseBody200 -> Encoding

toJSONList :: [GetInvoicesResponseBody200] -> Value

toEncodingList :: [GetInvoicesResponseBody200] -> Encoding

FromJSON GetInvoicesResponseBody200

Defined in StripeAPI.Operations.GetInvoices

Methods

parseJSON :: Value -> Parser GetInvoicesResponseBody200

parseJSONList :: Value -> Parser [GetInvoicesResponseBody200]

data GetInvoicesResponseBody200Object'

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 Text

GetInvoicesResponseBody200Object'EnumStringList

Instances

Eq GetInvoicesResponseBody200Object'

Defined in StripeAPI.Operations.GetInvoices

Methods

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

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

Show GetInvoicesResponseBody200Object'

Defined in StripeAPI.Operations.GetInvoices

Methods

showsPrec :: Int -> GetInvoicesResponseBody200Object' -> ShowS

show :: GetInvoicesResponseBody200Object' -> String

showList :: [GetInvoicesResponseBody200Object'] -> ShowS

ToJSON GetInvoicesResponseBody200Object'

Defined in StripeAPI.Operations.GetInvoices

Methods

toJSON :: GetInvoicesResponseBody200Object' -> Value

toEncoding :: GetInvoicesResponseBody200Object' -> Encoding

toJSONList :: [GetInvoicesResponseBody200Object'] -> Value

toEncodingList :: [GetInvoicesResponseBody200Object'] -> Encoding

FromJSON GetInvoicesResponseBody200Object'

Defined in StripeAPI.Operations.GetInvoices

Methods

parseJSON :: Value -> Parser GetInvoicesResponseBody200Object'

parseJSONList :: Value -> Parser [GetInvoicesResponseBody200Object']