StripeAPI.Operations.GetInvoiceitems

Contains the different functions to run the operation getInvoiceitems

Documentation

getInvoiceitems

Arguments

:: forall m. MonadHTTP m

=> GetInvoiceitemsParameters

Contains all available parameters of this operation (query and path parameters)

-> StripeT m (Response GetInvoiceitemsResponse)

Monadic computation which returns 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>

data GetInvoiceitemsParameters

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

Constructors

GetInvoiceitemsParameters

Fields

• getInvoiceitemsParametersQueryCreated :: Maybe GetInvoiceitemsParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

• getInvoiceitemsParametersQueryCustomer :: Maybe Text

  queryCustomer: Represents the parameter named '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
• getInvoiceitemsParametersQueryEndingBefore :: 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.

  Constraints:

  • Maximum length of 5000
• getInvoiceitemsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getInvoiceitemsParametersQueryInvoice :: Maybe Text

  queryInvoice: Represents the parameter named '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
• getInvoiceitemsParametersQueryLimit :: 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.

• getInvoiceitemsParametersQueryPending :: Maybe Bool

  queryPending: Represents the parameter named '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.

• getInvoiceitemsParametersQueryStartingAfter :: 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.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetInvoiceitemsParameters

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

(==) :: GetInvoiceitemsParameters -> GetInvoiceitemsParameters -> Bool

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

Show GetInvoiceitemsParameters

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

showsPrec :: Int -> GetInvoiceitemsParameters -> ShowS

show :: GetInvoiceitemsParameters -> String

showList :: [GetInvoiceitemsParameters] -> ShowS

ToJSON GetInvoiceitemsParameters

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

toJSON :: GetInvoiceitemsParameters -> Value

toEncoding :: GetInvoiceitemsParameters -> Encoding

toJSONList :: [GetInvoiceitemsParameters] -> Value

toEncodingList :: [GetInvoiceitemsParameters] -> Encoding

FromJSON GetInvoiceitemsParameters

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

parseJSON :: Value -> Parser GetInvoiceitemsParameters

parseJSONList :: Value -> Parser [GetInvoiceitemsParameters]

mkGetInvoiceitemsParameters :: GetInvoiceitemsParameters

Create a new GetInvoiceitemsParameters with all required fields.

data GetInvoiceitemsParametersQueryCreated'OneOf1

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

Constructors

GetInvoiceitemsParametersQueryCreated'OneOf1

Fields

• getInvoiceitemsParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getInvoiceitemsParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getInvoiceitemsParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getInvoiceitemsParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetInvoiceitemsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

(==) :: GetInvoiceitemsParametersQueryCreated'OneOf1 -> GetInvoiceitemsParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetInvoiceitemsParametersQueryCreated'OneOf1 -> GetInvoiceitemsParametersQueryCreated'OneOf1 -> Bool

Show GetInvoiceitemsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

showsPrec :: Int -> GetInvoiceitemsParametersQueryCreated'OneOf1 -> ShowS

show :: GetInvoiceitemsParametersQueryCreated'OneOf1 -> String

showList :: [GetInvoiceitemsParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetInvoiceitemsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

toJSON :: GetInvoiceitemsParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetInvoiceitemsParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetInvoiceitemsParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetInvoiceitemsParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetInvoiceitemsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

parseJSON :: Value -> Parser GetInvoiceitemsParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetInvoiceitemsParametersQueryCreated'OneOf1]

mkGetInvoiceitemsParametersQueryCreated'OneOf1 :: GetInvoiceitemsParametersQueryCreated'OneOf1

Create a new GetInvoiceitemsParametersQueryCreated'OneOf1 with all required fields.

data GetInvoiceitemsParametersQueryCreated'Variants

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

Represents the parameter named 'created'

Constructors

GetInvoiceitemsParametersQueryCreated'GetInvoiceitemsParametersQueryCreated'OneOf1 GetInvoiceitemsParametersQueryCreated'OneOf1

GetInvoiceitemsParametersQueryCreated'Int Int

Instances

Eq GetInvoiceitemsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

(==) :: GetInvoiceitemsParametersQueryCreated'Variants -> GetInvoiceitemsParametersQueryCreated'Variants -> Bool

(/=) :: GetInvoiceitemsParametersQueryCreated'Variants -> GetInvoiceitemsParametersQueryCreated'Variants -> Bool

Show GetInvoiceitemsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

showsPrec :: Int -> GetInvoiceitemsParametersQueryCreated'Variants -> ShowS

show :: GetInvoiceitemsParametersQueryCreated'Variants -> String

showList :: [GetInvoiceitemsParametersQueryCreated'Variants] -> ShowS

ToJSON GetInvoiceitemsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

toJSON :: GetInvoiceitemsParametersQueryCreated'Variants -> Value

toEncoding :: GetInvoiceitemsParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetInvoiceitemsParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetInvoiceitemsParametersQueryCreated'Variants] -> Encoding

FromJSON GetInvoiceitemsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetInvoiceitems

Methods

parseJSON :: Value -> Parser GetInvoiceitemsParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetInvoiceitemsParametersQueryCreated'Variants]

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 object schema located at paths./v1/invoiceitems.GET.responses.200.content.application/json.schema in the specification.

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.

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

mkGetInvoiceitemsResponseBody200

Arguments

:: [Invoiceitem]

getInvoiceitemsResponseBody200Data

-> Bool

getInvoiceitemsResponseBody200HasMore

-> Text

getInvoiceitemsResponseBody200Url

-> GetInvoiceitemsResponseBody200

Create a new GetInvoiceitemsResponseBody200 with all required fields.