stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostTopupsTopup

Description

Contains the different functions to run the operation postTopupsTopup

Synopsis

Documentation

postTopupsTopup Source #

Arguments

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

The configuration to use in the request

-> String

topup | Constraints: Maximum length of 5000

-> PostTopupsTopupRequestBody

The request body to send

-> m (Either HttpException (Response PostTopupsTopupResponse))

Monad containing the result of the operation

POST /v1/topups/{topup}

<p>Updates the metadata of a top-up. Other top-up details are not editable by design.</p>

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

POST /v1/topups/{topup}

The same as postTopupsTopup but returns the raw ByteString

data PostTopupsTopupRequestBody Source #

Defines the data type for the schema postTopupsTopupRequestBody

Constructors

PostTopupsTopupRequestBody 

Fields

data PostTopupsTopupRequestBodyMetadata' Source #

Defines the data type for the schema postTopupsTopupRequestBodyMetadata'

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

data PostTopupsTopupResponse Source #

Represents a response of the operation postTopupsTopup.

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

Constructors

PostTopupsTopupResponseError String

Means either no matching case available or a parse error

PostTopupsTopupResponse200 Topup

Successful response.

PostTopupsTopupResponseDefault Error

Error response.