Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostCreditNotesIdVoid

Contains the different functions to run the operation postCreditNotesIdVoid

2 types
2 values

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostCreditNotesIdVoid.hs

valuepostCreditNotesIdVoid

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

datadata PostCreditNotesIdVoidRequestBody

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
- postCreditNotesIdVoidRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCreditNotesIdVoidRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesIdVoid
Show PostCreditNotesIdVoidRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesIdVoid
FromJSON PostCreditNotesIdVoidRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesIdVoid
ToJSON PostCreditNotesIdVoidRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesIdVoid

valuemkPostCreditNotesIdVoidRequestBody :: PostCreditNotesIdVoidRequestBody

Create a new PostCreditNotesIdVoidRequestBody with all required fields.

datadata PostCreditNotesIdVoidResponse

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.

Instances2Eq, Show

Eq PostCreditNotesIdVoidResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesIdVoid
Show PostCreditNotesIdVoidResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesIdVoid