Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetCreditNotesCreditNoteLines

Contains the different functions to run the operation getCreditNotesCreditNoteLines

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetCreditNotesCreditNoteLines.hs

valuegetCreditNotesCreditNoteLines

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

datadata GetCreditNotesCreditNoteLinesParameters

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCreditNotesCreditNoteLinesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines
Show GetCreditNotesCreditNoteLinesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines
FromJSON GetCreditNotesCreditNoteLinesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines
ToJSON GetCreditNotesCreditNoteLinesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines

valuemkGetCreditNotesCreditNoteLinesParameters

:: Text
getCreditNotesCreditNoteLinesParametersPathCreditNote
-> GetCreditNotesCreditNoteLinesParameters

Create a new GetCreditNotesCreditNoteLinesParameters with all required fields.

datadata GetCreditNotesCreditNoteLinesResponse

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.

Instances2Eq, Show

Eq GetCreditNotesCreditNoteLinesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines
Show GetCreditNotesCreditNoteLinesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines

datadata GetCreditNotesCreditNoteLinesResponseBody200

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCreditNotesCreditNoteLinesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines
Show GetCreditNotesCreditNoteLinesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines
FromJSON GetCreditNotesCreditNoteLinesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines
ToJSON GetCreditNotesCreditNoteLinesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesCreditNoteLines

valuemkGetCreditNotesCreditNoteLinesResponseBody200

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

Create a new GetCreditNotesCreditNoteLinesResponseBody200 with all required fields.