Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostCreditNotesId

Contains the different functions to run the operation postCreditNotesId

2 types
2 values

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostCreditNotesId.hs

valuepostCreditNotesId

:: MonadHTTP m
=> Text
id | Constraints: Maximum length of 5000
-> Maybe PostCreditNotesIdRequestBody
The request body to send
-> ClientT m (Response PostCreditNotesIdResponse)
Monadic computation which returns the result of the operation

POST /v1/credit_notes/{id}

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

datadata PostCreditNotesIdRequestBody

Defines the object schema located at paths./v1/credit_notes/{id}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostCreditNotesIdRequestBody
- postCreditNotesIdRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postCreditNotesIdRequestBodyMemo :: Maybe Text
  memo: Credit note memo.
  Constraints:
  - Maximum length of 5000
- postCreditNotesIdRequestBodyMetadata :: Maybe Object
  metadata: 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`.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCreditNotesIdRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesId
Show PostCreditNotesIdRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesId
FromJSON PostCreditNotesIdRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesId
ToJSON PostCreditNotesIdRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesId

valuemkPostCreditNotesIdRequestBody :: PostCreditNotesIdRequestBody

Create a new PostCreditNotesIdRequestBody with all required fields.

datadata PostCreditNotesIdResponse

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.

Instances2Eq, Show

Eq PostCreditNotesIdResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesId
Show PostCreditNotesIdResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCreditNotesId