| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostCreditNotesIdVoid
Description
Contains the different functions to run the operation postCreditNotesIdVoid
Synopsis
- postCreditNotesIdVoid :: forall m. MonadHTTP m => Text -> Maybe PostCreditNotesIdVoidRequestBody -> ClientT m (Response PostCreditNotesIdVoidResponse)
- data PostCreditNotesIdVoidRequestBody = PostCreditNotesIdVoidRequestBody {}
- mkPostCreditNotesIdVoidRequestBody :: PostCreditNotesIdVoidRequestBody
- data PostCreditNotesIdVoidResponse
Documentation
postCreditNotesIdVoid Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | id | Constraints: Maximum length of 5000 |
| -> Maybe PostCreditNotesIdVoidRequestBody | The request body to send |
| -> ClientT m (Response PostCreditNotesIdVoidResponse) | Monadic computation which returns 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>
data PostCreditNotesIdVoidRequestBody Source #
Defines the object schema located at paths./v1/credit_notes/{id}/void.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostCreditNotesIdVoidRequestBody | |
Fields
| |
Instances
mkPostCreditNotesIdVoidRequestBody :: PostCreditNotesIdVoidRequestBody Source #
Create a new PostCreditNotesIdVoidRequestBody with all required 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. |