StripeAPI.Operations.GetCreditNotes

Contains the different functions to run the operation getCreditNotes

Documentation

getCreditNotes

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

customer: Only return credit notes for the customer specified by this customer ID. | Constraints: Maximum length of 5000

-> Maybe Text

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 Text

expand: Specifies which fields in the response should be expanded.

-> Maybe Text

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 Text

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

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

getCreditNotesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/credit_notes

The same as getCreditNotes but returns the raw ByteString

getCreditNotesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesResponse))

GET /v1/credit_notes

Monadic version of getCreditNotes (use with runWithConfiguration)

getCreditNotesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/credit_notes

Monadic version of getCreditNotesRaw (use with runWithConfiguration)

data GetCreditNotesRequestBody

Defines the data type for the schema getCreditNotesRequestBody

Constructors

GetCreditNotesRequestBody

Instances

Eq GetCreditNotesRequestBody

Defined in StripeAPI.Operations.GetCreditNotes

Methods

(==) :: GetCreditNotesRequestBody -> GetCreditNotesRequestBody -> Bool

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

Show GetCreditNotesRequestBody

Defined in StripeAPI.Operations.GetCreditNotes

Methods

showsPrec :: Int -> GetCreditNotesRequestBody -> ShowS

show :: GetCreditNotesRequestBody -> String

showList :: [GetCreditNotesRequestBody] -> ShowS

ToJSON GetCreditNotesRequestBody

Defined in StripeAPI.Operations.GetCreditNotes

Methods

toJSON :: GetCreditNotesRequestBody -> Value

toEncoding :: GetCreditNotesRequestBody -> Encoding

toJSONList :: [GetCreditNotesRequestBody] -> Value

toEncodingList :: [GetCreditNotesRequestBody] -> Encoding

FromJSON GetCreditNotesRequestBody

Defined in StripeAPI.Operations.GetCreditNotes

Methods

parseJSON :: Value -> Parser GetCreditNotesRequestBody

parseJSONList :: Value -> Parser [GetCreditNotesRequestBody]

data GetCreditNotesResponse

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.

Instances

Eq GetCreditNotesResponse

Defined in StripeAPI.Operations.GetCreditNotes

Methods

(==) :: GetCreditNotesResponse -> GetCreditNotesResponse -> Bool

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

Show GetCreditNotesResponse

Defined in StripeAPI.Operations.GetCreditNotes

Methods

showsPrec :: Int -> GetCreditNotesResponse -> ShowS

show :: GetCreditNotesResponse -> String

showList :: [GetCreditNotesResponse] -> ShowS

data GetCreditNotesResponseBody200

Defines the data type for the schema GetCreditNotesResponseBody200

Constructors

GetCreditNotesResponseBody200

Fields

• getCreditNotesResponseBody200Data :: [] CreditNote

  data

• getCreditNotesResponseBody200HasMore :: Bool

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

• getCreditNotesResponseBody200Object :: GetCreditNotesResponseBody200Object'

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

• getCreditNotesResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetCreditNotesResponseBody200

Defined in StripeAPI.Operations.GetCreditNotes

Methods

(==) :: GetCreditNotesResponseBody200 -> GetCreditNotesResponseBody200 -> Bool

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

Show GetCreditNotesResponseBody200

Defined in StripeAPI.Operations.GetCreditNotes

Methods

showsPrec :: Int -> GetCreditNotesResponseBody200 -> ShowS

show :: GetCreditNotesResponseBody200 -> String

showList :: [GetCreditNotesResponseBody200] -> ShowS

ToJSON GetCreditNotesResponseBody200

Defined in StripeAPI.Operations.GetCreditNotes

Methods

toJSON :: GetCreditNotesResponseBody200 -> Value

toEncoding :: GetCreditNotesResponseBody200 -> Encoding

toJSONList :: [GetCreditNotesResponseBody200] -> Value

toEncodingList :: [GetCreditNotesResponseBody200] -> Encoding

FromJSON GetCreditNotesResponseBody200

Defined in StripeAPI.Operations.GetCreditNotes

Methods

parseJSON :: Value -> Parser GetCreditNotesResponseBody200

parseJSONList :: Value -> Parser [GetCreditNotesResponseBody200]

data GetCreditNotesResponseBody200Object'

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

Constructors

GetCreditNotesResponseBody200Object'EnumOther Value

GetCreditNotesResponseBody200Object'EnumTyped Text

GetCreditNotesResponseBody200Object'EnumStringList

Instances

Eq GetCreditNotesResponseBody200Object'

Defined in StripeAPI.Operations.GetCreditNotes

Methods

(==) :: GetCreditNotesResponseBody200Object' -> GetCreditNotesResponseBody200Object' -> Bool

(/=) :: GetCreditNotesResponseBody200Object' -> GetCreditNotesResponseBody200Object' -> Bool

Show GetCreditNotesResponseBody200Object'

Defined in StripeAPI.Operations.GetCreditNotes

Methods

showsPrec :: Int -> GetCreditNotesResponseBody200Object' -> ShowS

show :: GetCreditNotesResponseBody200Object' -> String

showList :: [GetCreditNotesResponseBody200Object'] -> ShowS

ToJSON GetCreditNotesResponseBody200Object'

Defined in StripeAPI.Operations.GetCreditNotes

Methods

toJSON :: GetCreditNotesResponseBody200Object' -> Value

toEncoding :: GetCreditNotesResponseBody200Object' -> Encoding

toJSONList :: [GetCreditNotesResponseBody200Object'] -> Value

toEncodingList :: [GetCreditNotesResponseBody200Object'] -> Encoding

FromJSON GetCreditNotesResponseBody200Object'

Defined in StripeAPI.Operations.GetCreditNotes

Methods

parseJSON :: Value -> Parser GetCreditNotesResponseBody200Object'

parseJSONList :: Value -> Parser [GetCreditNotesResponseBody200Object']