StripeAPI.Operations.GetCreditNotes

Contains the different functions to run the operation getCreditNotes

Documentation

getCreditNotes

Arguments

:: forall m. MonadHTTP m

=> GetCreditNotesParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetCreditNotesResponse)

Monadic computation which returns the result of the operation

GET /v1/credit_notes

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

data GetCreditNotesParameters

Defines the object schema located at paths./v1/credit_notes.GET.parameters in the specification.

Constructors

GetCreditNotesParameters

Fields

• getCreditNotesParametersQueryCustomer :: Maybe Text

  queryCustomer: Represents the parameter named 'customer'

  Only return credit notes for the customer specified by this customer ID.

  Constraints:

  • Maximum length of 5000
• getCreditNotesParametersQueryEndingBefore :: 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
• getCreditNotesParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getCreditNotesParametersQueryInvoice :: Maybe Text

  queryInvoice: Represents the parameter named 'invoice'

  Only return credit notes for the invoice specified by this invoice ID.

  Constraints:

  • Maximum length of 5000
• getCreditNotesParametersQueryLimit :: 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.

• getCreditNotesParametersQueryStartingAfter :: 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

Eq GetCreditNotesParameters

Defined in StripeAPI.Operations.GetCreditNotes

Methods

(==) :: GetCreditNotesParameters -> GetCreditNotesParameters -> Bool

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

Show GetCreditNotesParameters

Defined in StripeAPI.Operations.GetCreditNotes

Methods

showsPrec :: Int -> GetCreditNotesParameters -> ShowS

show :: GetCreditNotesParameters -> String

showList :: [GetCreditNotesParameters] -> ShowS

ToJSON GetCreditNotesParameters

Defined in StripeAPI.Operations.GetCreditNotes

Methods

toJSON :: GetCreditNotesParameters -> Value

toEncoding :: GetCreditNotesParameters -> Encoding

toJSONList :: [GetCreditNotesParameters] -> Value

toEncodingList :: [GetCreditNotesParameters] -> Encoding

FromJSON GetCreditNotesParameters

Defined in StripeAPI.Operations.GetCreditNotes

Methods

parseJSON :: Value -> Parser GetCreditNotesParameters

parseJSONList :: Value -> Parser [GetCreditNotesParameters]

mkGetCreditNotesParameters :: GetCreditNotesParameters

Create a new GetCreditNotesParameters with all required fields.

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 object schema located at paths./v1/credit_notes.GET.responses.200.content.application/json.schema in the specification.

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.

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

mkGetCreditNotesResponseBody200

Arguments

:: [CreditNote]

getCreditNotesResponseBody200Data

-> Bool

getCreditNotesResponseBody200HasMore

-> Text

getCreditNotesResponseBody200Url

-> GetCreditNotesResponseBody200

Create a new GetCreditNotesResponseBody200 with all required fields.