StripeAPI.Operations.GetInvoiceitems

Contains the different functions to run the operation getInvoiceitems

Documentation

getInvoiceitems

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

created

-> Maybe Text

customer: The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. | Constraints: Maximum length of 5000

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

invoice: Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed. | Constraints: Maximum length of 5000

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

pending: Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.

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

The request body to send

-> m (Either HttpException (Response GetInvoiceitemsResponse))

Monad containing the result of the operation

GET /v1/invoiceitems

<p>Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.</p>

getInvoiceitemsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Bool -> Maybe Text -> Maybe GetInvoiceitemsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/invoiceitems

The same as getInvoiceitems but returns the raw ByteString

getInvoiceitemsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Bool -> Maybe Text -> Maybe GetInvoiceitemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetInvoiceitemsResponse))

GET /v1/invoiceitems

Monadic version of getInvoiceitems (use with runWithConfiguration)

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

GET /v1/invoiceitems

Monadic version of getInvoiceitemsRaw (use with runWithConfiguration)

data GetInvoiceitemsRequestBody

Defines the data type for the schema getInvoiceitemsRequestBody

Constructors

GetInvoiceitemsRequestBody

Instances

Eq GetInvoiceitemsRequestBody

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

(==) :: GetInvoiceitemsRequestBody -> GetInvoiceitemsRequestBody -> Bool

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

Show GetInvoiceitemsRequestBody

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

showsPrec :: Int -> GetInvoiceitemsRequestBody -> ShowS

show :: GetInvoiceitemsRequestBody -> String

showList :: [GetInvoiceitemsRequestBody] -> ShowS

ToJSON GetInvoiceitemsRequestBody

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

toJSON :: GetInvoiceitemsRequestBody -> Value

toEncoding :: GetInvoiceitemsRequestBody -> Encoding

toJSONList :: [GetInvoiceitemsRequestBody] -> Value

toEncodingList :: [GetInvoiceitemsRequestBody] -> Encoding

FromJSON GetInvoiceitemsRequestBody

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

parseJSON :: Value -> Parser GetInvoiceitemsRequestBody

parseJSONList :: Value -> Parser [GetInvoiceitemsRequestBody]

data GetInvoiceitemsResponse

Represents a response of the operation getInvoiceitems.

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), GetInvoiceitemsResponseError is used.

Constructors

GetInvoiceitemsResponseError String

Means either no matching case available or a parse error

GetInvoiceitemsResponse200 GetInvoiceitemsResponseBody200

Successful response.

GetInvoiceitemsResponseDefault Error

Error response.

Instances

Eq GetInvoiceitemsResponse

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

(==) :: GetInvoiceitemsResponse -> GetInvoiceitemsResponse -> Bool

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

Show GetInvoiceitemsResponse

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

showsPrec :: Int -> GetInvoiceitemsResponse -> ShowS

show :: GetInvoiceitemsResponse -> String

showList :: [GetInvoiceitemsResponse] -> ShowS

data GetInvoiceitemsResponseBody200

Defines the data type for the schema GetInvoiceitemsResponseBody200

Constructors

GetInvoiceitemsResponseBody200

Fields

• getInvoiceitemsResponseBody200Data :: [] Invoiceitem

  data

• getInvoiceitemsResponseBody200HasMore :: Bool

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

• getInvoiceitemsResponseBody200Object :: GetInvoiceitemsResponseBody200Object'

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

• getInvoiceitemsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetInvoiceitemsResponseBody200

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

(==) :: GetInvoiceitemsResponseBody200 -> GetInvoiceitemsResponseBody200 -> Bool

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

Show GetInvoiceitemsResponseBody200

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

showsPrec :: Int -> GetInvoiceitemsResponseBody200 -> ShowS

show :: GetInvoiceitemsResponseBody200 -> String

showList :: [GetInvoiceitemsResponseBody200] -> ShowS

ToJSON GetInvoiceitemsResponseBody200

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

toJSON :: GetInvoiceitemsResponseBody200 -> Value

toEncoding :: GetInvoiceitemsResponseBody200 -> Encoding

toJSONList :: [GetInvoiceitemsResponseBody200] -> Value

toEncodingList :: [GetInvoiceitemsResponseBody200] -> Encoding

FromJSON GetInvoiceitemsResponseBody200

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

parseJSON :: Value -> Parser GetInvoiceitemsResponseBody200

parseJSONList :: Value -> Parser [GetInvoiceitemsResponseBody200]

data GetInvoiceitemsResponseBody200Object'

Defines the enum schema GetInvoiceitemsResponseBody200Object'

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

Constructors

GetInvoiceitemsResponseBody200Object'EnumOther Value

GetInvoiceitemsResponseBody200Object'EnumTyped Text

GetInvoiceitemsResponseBody200Object'EnumStringList

Instances

Eq GetInvoiceitemsResponseBody200Object'

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

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

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

Show GetInvoiceitemsResponseBody200Object'

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

showsPrec :: Int -> GetInvoiceitemsResponseBody200Object' -> ShowS

show :: GetInvoiceitemsResponseBody200Object' -> String

showList :: [GetInvoiceitemsResponseBody200Object'] -> ShowS

ToJSON GetInvoiceitemsResponseBody200Object'

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

toJSON :: GetInvoiceitemsResponseBody200Object' -> Value

toEncoding :: GetInvoiceitemsResponseBody200Object' -> Encoding

toJSONList :: [GetInvoiceitemsResponseBody200Object'] -> Value

toEncodingList :: [GetInvoiceitemsResponseBody200Object'] -> Encoding

FromJSON GetInvoiceitemsResponseBody200Object'

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

parseJSON :: Value -> Parser GetInvoiceitemsResponseBody200Object'

parseJSONList :: Value -> Parser [GetInvoiceitemsResponseBody200Object']