stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetCreditNotesCreditNoteLines

Description

Contains the different functions to run the operation getCreditNotesCreditNoteLines

Synopsis

Documentation

getCreditNotesCreditNoteLines Source #

Arguments

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

The configuration to use in the request

-> String

credit_note | Constraints: Maximum length of 5000

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

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

-> GetCreditNotesCreditNoteLinesRequestBody

The request body to send

-> m (Either HttpException (Response GetCreditNotesCreditNoteLinesResponse))

Monad containing 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 GetCreditNotesCreditNoteLinesRequestBody Source #

Defines the data type for the schema getCreditNotesCreditNoteLinesRequestBody

data GetCreditNotesCreditNoteLinesResponseBody200 Source #

Defines the data type for the schema GetCreditNotesCreditNoteLinesResponseBody200

Constructors

GetCreditNotesCreditNoteLinesResponseBody200 

Fields

data GetCreditNotesCreditNoteLinesResponseBody200Object' Source #

Defines the enum schema GetCreditNotesCreditNoteLinesResponseBody200Object'

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

Instances
Eq GetCreditNotesCreditNoteLinesResponseBody200Object' Source # 
Instance details

Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines

Show GetCreditNotesCreditNoteLinesResponseBody200Object' Source # 
Instance details

Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines

ToJSON GetCreditNotesCreditNoteLinesResponseBody200Object' Source # 
Instance details

Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines

FromJSON GetCreditNotesCreditNoteLinesResponseBody200Object' Source # 
Instance details

Defined in StripeAPI.Operations.GetCreditNotesCreditNoteLines