stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostCreditNotesIdVoid

Description

Contains the different functions to run the operation postCreditNotesIdVoid

Synopsis

Documentation

postCreditNotesIdVoid Source #

Arguments

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

The configuration to use in the request

-> String

id | Constraints: Maximum length of 5000

-> PostCreditNotesIdVoidRequestBody

The request body to send

-> m (Either HttpException (Response PostCreditNotesIdVoidResponse))

Monad containing the result of the operation

POST /v1/credit_notes/{id}/void

<p>Marks a credit note as void. Learn more about <a href="/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>.</p>

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

POST /v1/credit_notes/{id}/void

The same as postCreditNotesIdVoid but returns the raw ByteString

data PostCreditNotesIdVoidRequestBody Source #

Defines the data type for the schema postCreditNotesIdVoidRequestBody

Constructors

PostCreditNotesIdVoidRequestBody 

Fields

data PostCreditNotesIdVoidResponse Source #

Represents a response of the operation postCreditNotesIdVoid.

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

Constructors

PostCreditNotesIdVoidResponseError String

Means either no matching case available or a parse error

PostCreditNotesIdVoidResponse200 CreditNote

Successful response.

PostCreditNotesIdVoidResponseDefault Error

Error response.