StripeAPI.Operations.PostCreditNotesId

Contains the different functions to run the operation postCreditNotesId

Documentation

postCreditNotesId

Arguments

:: forall m. 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>

data 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

Fields

• 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`.

Instances

Eq PostCreditNotesIdRequestBody

Defined in StripeAPI.Operations.PostCreditNotesId

Methods

(==) :: PostCreditNotesIdRequestBody -> PostCreditNotesIdRequestBody -> Bool

(/=) :: PostCreditNotesIdRequestBody -> PostCreditNotesIdRequestBody -> Bool

Show PostCreditNotesIdRequestBody

Defined in StripeAPI.Operations.PostCreditNotesId

Methods

showsPrec :: Int -> PostCreditNotesIdRequestBody -> ShowS

show :: PostCreditNotesIdRequestBody -> String

showList :: [PostCreditNotesIdRequestBody] -> ShowS

ToJSON PostCreditNotesIdRequestBody

Defined in StripeAPI.Operations.PostCreditNotesId

Methods

toJSON :: PostCreditNotesIdRequestBody -> Value

toEncoding :: PostCreditNotesIdRequestBody -> Encoding

toJSONList :: [PostCreditNotesIdRequestBody] -> Value

toEncodingList :: [PostCreditNotesIdRequestBody] -> Encoding

FromJSON PostCreditNotesIdRequestBody

Defined in StripeAPI.Operations.PostCreditNotesId

Methods

parseJSON :: Value -> Parser PostCreditNotesIdRequestBody

parseJSONList :: Value -> Parser [PostCreditNotesIdRequestBody]

mkPostCreditNotesIdRequestBody :: PostCreditNotesIdRequestBody

Create a new PostCreditNotesIdRequestBody with all required fields.

data 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.

Instances

Eq PostCreditNotesIdResponse

Defined in StripeAPI.Operations.PostCreditNotesId

Methods

(==) :: PostCreditNotesIdResponse -> PostCreditNotesIdResponse -> Bool

(/=) :: PostCreditNotesIdResponse -> PostCreditNotesIdResponse -> Bool

Show PostCreditNotesIdResponse

Defined in StripeAPI.Operations.PostCreditNotesId

Methods

showsPrec :: Int -> PostCreditNotesIdResponse -> ShowS

show :: PostCreditNotesIdResponse -> String

showList :: [PostCreditNotesIdResponse] -> ShowS