stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetInvoicesInvoiceLines

Description

Contains the different functions to run the operation getInvoicesInvoiceLines

Synopsis

Documentation

getInvoicesInvoiceLines Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

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

-> String

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

-> GetInvoicesInvoiceLinesRequestBody

The request body to send

-> m (Either HttpException (Response GetInvoicesInvoiceLinesResponse))

Monad containing the result of the operation

GET /v1/invoices/{invoice}/lines

<p>When retrieving an invoice, you’ll get a <strong>lines</strong> property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>

data GetInvoicesInvoiceLinesResponse Source #

Represents a response of the operation getInvoicesInvoiceLines.

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

Constructors

GetInvoicesInvoiceLinesResponseError String

Means either no matching case available or a parse error

GetInvoicesInvoiceLinesResponse200 GetInvoicesInvoiceLinesResponseBody200

Successful response.

GetInvoicesInvoiceLinesResponseDefault Error

Error response.

data GetInvoicesInvoiceLinesResponseBody200 Source #

Defines the data type for the schema GetInvoicesInvoiceLinesResponseBody200

Constructors

GetInvoicesInvoiceLinesResponseBody200 

Fields

data GetInvoicesInvoiceLinesResponseBody200Object' Source #

Defines the enum schema GetInvoicesInvoiceLinesResponseBody200Object'

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