Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCreditNotesCreditNoteLines

Description

Contains the different functions to run the operation getCreditNotesCreditNoteLines

Synopsis

getCreditNotesCreditNoteLines :: forall m. MonadHTTP m => GetCreditNotesCreditNoteLinesParameters -> StripeT m (Response GetCreditNotesCreditNoteLinesResponse)
data GetCreditNotesCreditNoteLinesParameters = GetCreditNotesCreditNoteLinesParameters {
}
mkGetCreditNotesCreditNoteLinesParameters :: Text -> GetCreditNotesCreditNoteLinesParameters
data GetCreditNotesCreditNoteLinesResponse
data GetCreditNotesCreditNoteLinesResponseBody200 = GetCreditNotesCreditNoteLinesResponseBody200 {
}
mkGetCreditNotesCreditNoteLinesResponseBody200 :: [CreditNoteLineItem] -> Bool -> Text -> GetCreditNotesCreditNoteLinesResponseBody200

Documentation

getCreditNotesCreditNoteLines Source #

Arguments

:: forall m. MonadHTTP m
=> GetCreditNotesCreditNoteLinesParameters	Contains all available parameters of this operation (query and path parameters)
-> StripeT m (Response GetCreditNotesCreditNoteLinesResponse)	Monadic computation which returns the result of the operation

GET /v1/credit_notes/{credit_note}/lines

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

data GetCreditNotesCreditNoteLinesParameters Source #

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

Constructors

GetCreditNotesCreditNoteLinesParameters

Fields

getCreditNotesCreditNoteLinesParametersPathCreditNote :: Text
pathCredit_note: Represents the parameter named 'credit_note'
Constraints:
- Maximum length of 5000
getCreditNotesCreditNoteLinesParametersQueryEndingBefore :: 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
getCreditNotesCreditNoteLinesParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getCreditNotesCreditNoteLinesParametersQueryLimit :: 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.
getCreditNotesCreditNoteLinesParametersQueryStartingAfter :: 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

Instances details

Eq GetCreditNotesCreditNoteLinesParameters Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods (==) :: GetCreditNotesCreditNoteLinesParameters -> GetCreditNotesCreditNoteLinesParameters -> Bool # (/=) :: GetCreditNotesCreditNoteLinesParameters -> GetCreditNotesCreditNoteLinesParameters -> Bool #
Show GetCreditNotesCreditNoteLinesParameters Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods showsPrec :: Int -> GetCreditNotesCreditNoteLinesParameters -> ShowS # show :: GetCreditNotesCreditNoteLinesParameters -> String # showList :: [GetCreditNotesCreditNoteLinesParameters] -> ShowS #
ToJSON GetCreditNotesCreditNoteLinesParameters Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods toJSON :: GetCreditNotesCreditNoteLinesParameters -> Value # toEncoding :: GetCreditNotesCreditNoteLinesParameters -> Encoding # toJSONList :: [GetCreditNotesCreditNoteLinesParameters] -> Value # toEncodingList :: [GetCreditNotesCreditNoteLinesParameters] -> Encoding #
FromJSON GetCreditNotesCreditNoteLinesParameters Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods parseJSON :: Value -> Parser GetCreditNotesCreditNoteLinesParameters # parseJSONList :: Value -> Parser [GetCreditNotesCreditNoteLinesParameters] #

mkGetCreditNotesCreditNoteLinesParameters Source #

Arguments

:: Text	`getCreditNotesCreditNoteLinesParametersPathCreditNote`
-> GetCreditNotesCreditNoteLinesParameters

Create a new GetCreditNotesCreditNoteLinesParameters with all required fields.

data GetCreditNotesCreditNoteLinesResponse Source #

Represents a response of the operation getCreditNotesCreditNoteLines.

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

Constructors

GetCreditNotesCreditNoteLinesResponseError String	Means either no matching case available or a parse error
GetCreditNotesCreditNoteLinesResponse200 GetCreditNotesCreditNoteLinesResponseBody200	Successful response.
GetCreditNotesCreditNoteLinesResponseDefault Error	Error response.

Instances

Instances details

Eq GetCreditNotesCreditNoteLinesResponse Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods (==) :: GetCreditNotesCreditNoteLinesResponse -> GetCreditNotesCreditNoteLinesResponse -> Bool # (/=) :: GetCreditNotesCreditNoteLinesResponse -> GetCreditNotesCreditNoteLinesResponse -> Bool #
Show GetCreditNotesCreditNoteLinesResponse Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods showsPrec :: Int -> GetCreditNotesCreditNoteLinesResponse -> ShowS # show :: GetCreditNotesCreditNoteLinesResponse -> String # showList :: [GetCreditNotesCreditNoteLinesResponse] -> ShowS #

data GetCreditNotesCreditNoteLinesResponseBody200 Source #

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

Constructors

GetCreditNotesCreditNoteLinesResponseBody200

Fields

getCreditNotesCreditNoteLinesResponseBody200Data :: [CreditNoteLineItem]
data: Details about each object.
getCreditNotesCreditNoteLinesResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getCreditNotesCreditNoteLinesResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000

Instances

Instances details

Eq GetCreditNotesCreditNoteLinesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods (==) :: GetCreditNotesCreditNoteLinesResponseBody200 -> GetCreditNotesCreditNoteLinesResponseBody200 -> Bool # (/=) :: GetCreditNotesCreditNoteLinesResponseBody200 -> GetCreditNotesCreditNoteLinesResponseBody200 -> Bool #
Show GetCreditNotesCreditNoteLinesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods showsPrec :: Int -> GetCreditNotesCreditNoteLinesResponseBody200 -> ShowS # show :: GetCreditNotesCreditNoteLinesResponseBody200 -> String # showList :: [GetCreditNotesCreditNoteLinesResponseBody200] -> ShowS #
ToJSON GetCreditNotesCreditNoteLinesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods toJSON :: GetCreditNotesCreditNoteLinesResponseBody200 -> Value # toEncoding :: GetCreditNotesCreditNoteLinesResponseBody200 -> Encoding # toJSONList :: [GetCreditNotesCreditNoteLinesResponseBody200] -> Value # toEncodingList :: [GetCreditNotesCreditNoteLinesResponseBody200] -> Encoding #
FromJSON GetCreditNotesCreditNoteLinesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines Methods parseJSON :: Value -> Parser GetCreditNotesCreditNoteLinesResponseBody200 # parseJSONList :: Value -> Parser [GetCreditNotesCreditNoteLinesResponseBody200] #

mkGetCreditNotesCreditNoteLinesResponseBody200 Source #

Arguments

:: [CreditNoteLineItem]	`getCreditNotesCreditNoteLinesResponseBody200Data`
-> Bool	`getCreditNotesCreditNoteLinesResponseBody200HasMore`
-> Text	`getCreditNotesCreditNoteLinesResponseBody200Url`
-> GetCreditNotesCreditNoteLinesResponseBody200

Create a new GetCreditNotesCreditNoteLinesResponseBody200 with all required fields.