Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetInvoiceitems

Contains the different functions to run the operation getInvoiceitems

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetInvoiceitems.hs

valuegetInvoiceitems

:: MonadHTTP m
=> GetInvoiceitemsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT 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>

datadata GetInvoiceitemsParameters

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoiceitemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
Show GetInvoiceitemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
FromJSON GetInvoiceitemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
ToJSON GetInvoiceitemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems

valuemkGetInvoiceitemsParameters :: GetInvoiceitemsParameters

Create a new GetInvoiceitemsParameters with all required fields.

datadata GetInvoiceitemsParametersQueryCreated'OneOf1

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

Constructors

GetInvoiceitemsParametersQueryCreated'OneOf1
- getInvoiceitemsParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getInvoiceitemsParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getInvoiceitemsParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getInvoiceitemsParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoiceitemsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
Show GetInvoiceitemsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
FromJSON GetInvoiceitemsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
ToJSON GetInvoiceitemsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems

valuemkGetInvoiceitemsParametersQueryCreated'OneOf1 :: GetInvoiceitemsParametersQueryCreated'OneOf1

Create a new GetInvoiceitemsParametersQueryCreated'OneOf1 with all required fields.

datadata 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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoiceitemsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
Show GetInvoiceitemsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
FromJSON GetInvoiceitemsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
ToJSON GetInvoiceitemsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems

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

Instances2Eq, Show

Eq GetInvoiceitemsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
Show GetInvoiceitemsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems

datadata GetInvoiceitemsResponseBody200

Defines the object schema located at paths./v1/invoiceitems.GET.responses.200.content.application/json.schema in the specification.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoiceitemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
Show GetInvoiceitemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
FromJSON GetInvoiceitemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems
ToJSON GetInvoiceitemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoiceitems

valuemkGetInvoiceitemsResponseBody200

:: [Invoiceitem]
getInvoiceitemsResponseBody200Data
-> Bool
getInvoiceitemsResponseBody200HasMore
-> Text
getInvoiceitemsResponseBody200Url
-> GetInvoiceitemsResponseBody200

Create a new GetInvoiceitemsResponseBody200 with all required fields.