stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetCreditNotes

Description

Contains the different functions to run the operation getCreditNotes

Synopsis

Documentation

getCreditNotes Source #

Arguments

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

The configuration to use in the request

-> Maybe String

customer: Only return credit notes for the customer specified by this customer ID. | 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 String

invoice: Only return credit notes for the invoice specified by this invoice ID. | 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

-> GetCreditNotesRequestBody

The request body to send

-> m (Either HttpException (Response GetCreditNotesResponse))

Monad containing the result of the operation

GET /v1/credit_notes

<p>Returns a list of credit notes.</p>

data GetCreditNotesResponse Source #

Represents a response of the operation getCreditNotes.

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

Constructors

GetCreditNotesResponseError String

Means either no matching case available or a parse error

GetCreditNotesResponse200 GetCreditNotesResponseBody200

Successful response.

GetCreditNotesResponseDefault Error

Error response.

data GetCreditNotesResponseBody200 Source #

Defines the data type for the schema GetCreditNotesResponseBody200

Constructors

GetCreditNotesResponseBody200 

Fields

data GetCreditNotesResponseBody200Object' Source #

Defines the enum schema GetCreditNotesResponseBody200Object'

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