StripeAPI.Operations.GetInvoicesInvoiceLines

Contains the different functions to run the operation getInvoicesInvoiceLines

Documentation

getInvoicesInvoiceLines

Arguments

:: forall m. MonadHTTP m

=> GetInvoicesInvoiceLinesParameters

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

-> ClientT m (Response GetInvoicesInvoiceLinesResponse)

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

Defines the object schema located at paths./v1/invoices/{invoice}/lines.GET.parameters in the specification.

Constructors

GetInvoicesInvoiceLinesParameters

Fields

• getInvoicesInvoiceLinesParametersPathInvoice :: Text

  pathInvoice: Represents the parameter named 'invoice'

  Constraints:

  • Maximum length of 5000
• getInvoicesInvoiceLinesParametersQueryEndingBefore :: 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
• getInvoicesInvoiceLinesParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

• getInvoicesInvoiceLinesParametersQueryStartingAfter :: 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 GetInvoicesInvoiceLinesParameters

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

(==) :: GetInvoicesInvoiceLinesParameters -> GetInvoicesInvoiceLinesParameters -> Bool

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

Show GetInvoicesInvoiceLinesParameters

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

showsPrec :: Int -> GetInvoicesInvoiceLinesParameters -> ShowS

show :: GetInvoicesInvoiceLinesParameters -> String

showList :: [GetInvoicesInvoiceLinesParameters] -> ShowS

ToJSON GetInvoicesInvoiceLinesParameters

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

toJSON :: GetInvoicesInvoiceLinesParameters -> Value

toEncoding :: GetInvoicesInvoiceLinesParameters -> Encoding

toJSONList :: [GetInvoicesInvoiceLinesParameters] -> Value

toEncodingList :: [GetInvoicesInvoiceLinesParameters] -> Encoding

FromJSON GetInvoicesInvoiceLinesParameters

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

parseJSON :: Value -> Parser GetInvoicesInvoiceLinesParameters

parseJSONList :: Value -> Parser [GetInvoicesInvoiceLinesParameters]

mkGetInvoicesInvoiceLinesParameters

Arguments

:: Text

getInvoicesInvoiceLinesParametersPathInvoice

-> GetInvoicesInvoiceLinesParameters

Create a new GetInvoicesInvoiceLinesParameters with all required fields.

data GetInvoicesInvoiceLinesResponse

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.

Instances

Eq GetInvoicesInvoiceLinesResponse

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

(==) :: GetInvoicesInvoiceLinesResponse -> GetInvoicesInvoiceLinesResponse -> Bool

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

Show GetInvoicesInvoiceLinesResponse

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

showsPrec :: Int -> GetInvoicesInvoiceLinesResponse -> ShowS

show :: GetInvoicesInvoiceLinesResponse -> String

showList :: [GetInvoicesInvoiceLinesResponse] -> ShowS

data GetInvoicesInvoiceLinesResponseBody200

Defines the object schema located at paths./v1/invoices/{invoice}/lines.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetInvoicesInvoiceLinesResponseBody200

Fields

• getInvoicesInvoiceLinesResponseBody200Data :: [LineItem]

  data: Details about each object.

• getInvoicesInvoiceLinesResponseBody200HasMore :: Bool

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

• getInvoicesInvoiceLinesResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetInvoicesInvoiceLinesResponseBody200

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

(==) :: GetInvoicesInvoiceLinesResponseBody200 -> GetInvoicesInvoiceLinesResponseBody200 -> Bool

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

Show GetInvoicesInvoiceLinesResponseBody200

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

showsPrec :: Int -> GetInvoicesInvoiceLinesResponseBody200 -> ShowS

show :: GetInvoicesInvoiceLinesResponseBody200 -> String

showList :: [GetInvoicesInvoiceLinesResponseBody200] -> ShowS

ToJSON GetInvoicesInvoiceLinesResponseBody200

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

toJSON :: GetInvoicesInvoiceLinesResponseBody200 -> Value

toEncoding :: GetInvoicesInvoiceLinesResponseBody200 -> Encoding

toJSONList :: [GetInvoicesInvoiceLinesResponseBody200] -> Value

toEncodingList :: [GetInvoicesInvoiceLinesResponseBody200] -> Encoding

FromJSON GetInvoicesInvoiceLinesResponseBody200

Defined in StripeAPI.Operations.GetInvoicesInvoiceLines

Methods

parseJSON :: Value -> Parser GetInvoicesInvoiceLinesResponseBody200

parseJSONList :: Value -> Parser [GetInvoicesInvoiceLinesResponseBody200]

mkGetInvoicesInvoiceLinesResponseBody200

Arguments

:: [LineItem]

getInvoicesInvoiceLinesResponseBody200Data

-> Bool

getInvoicesInvoiceLinesResponseBody200HasMore

-> Text

getInvoicesInvoiceLinesResponseBody200Url

-> GetInvoicesInvoiceLinesResponseBody200

Create a new GetInvoicesInvoiceLinesResponseBody200 with all required fields.