stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostCreditNotesId

Description

Contains the different functions to run the operation postCreditNotesId

Synopsis

Documentation

postCreditNotesId Source #

Arguments

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

The configuration to use in the request

-> String

id | Constraints: Maximum length of 5000

-> PostCreditNotesIdRequestBody

The request body to send

-> m (Either HttpException (Response PostCreditNotesIdResponse))

Monad containing the result of the operation

POST /v1/credit_notes/{id}

<p>Updates an existing credit note.</p>

postCreditNotesIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostCreditNotesIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/credit_notes/{id}

The same as postCreditNotesId but returns the raw ByteString

data PostCreditNotesIdRequestBody Source #

Defines the data type for the schema postCreditNotesIdRequestBody

Constructors

PostCreditNotesIdRequestBody 

Fields

data PostCreditNotesIdRequestBodyMetadata' Source #

Defines the data type for the schema postCreditNotesIdRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

data PostCreditNotesIdResponse Source #

Represents a response of the operation postCreditNotesId.

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

Constructors

PostCreditNotesIdResponseError String

Means either no matching case available or a parse error

PostCreditNotesIdResponse200 CreditNote

Successful response.

PostCreditNotesIdResponseDefault Error

Error response.