StripeAPI.Operations.DeleteAccount

Contains the different functions to run the operation deleteAccount

Documentation

deleteAccount

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> DeleteAccountRequestBody

The request body to send

-> m (Either HttpException (Response DeleteAccountResponse))

Monad containing the result of the operation

DELETE /v1/account

<p>With <a href="/docs/connect">Connect</a>, you can delete Custom or Express accounts you manage.</p>

<p>Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted once all balances are zero.</p>

<p>If you want to delete your own account, use the <a href="https://dashboard.stripe.com/account">account information tab in your account settings</a> instead.</p>

deleteAccountRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> DeleteAccountRequestBody -> m (Either HttpException (Response ByteString))

DELETE /v1/account

The same as deleteAccount but returns the raw ByteString

deleteAccountM :: forall m s. (MonadHTTP m, SecurityScheme s) => DeleteAccountRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteAccountResponse))

DELETE /v1/account

Monadic version of deleteAccount (use with runWithConfiguration)

deleteAccountRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => DeleteAccountRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

DELETE /v1/account

Monadic version of deleteAccountRaw (use with runWithConfiguration)

data DeleteAccountRequestBody

Defines the data type for the schema deleteAccountRequestBody

Constructors

DeleteAccountRequestBody

Fields

• deleteAccountRequestBodyAccount :: Maybe String

  account

  Constraints:

  • Maximum length of 5000

Instances

Eq DeleteAccountRequestBody

Defined in StripeAPI.Operations.DeleteAccount

Methods

(==) :: DeleteAccountRequestBody -> DeleteAccountRequestBody -> Bool

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

Show DeleteAccountRequestBody

Defined in StripeAPI.Operations.DeleteAccount

Methods

showsPrec :: Int -> DeleteAccountRequestBody -> ShowS

show :: DeleteAccountRequestBody -> String

showList :: [DeleteAccountRequestBody] -> ShowS

ToJSON DeleteAccountRequestBody

Defined in StripeAPI.Operations.DeleteAccount

Methods

toJSON :: DeleteAccountRequestBody -> Value

toEncoding :: DeleteAccountRequestBody -> Encoding

toJSONList :: [DeleteAccountRequestBody] -> Value

toEncodingList :: [DeleteAccountRequestBody] -> Encoding

FromJSON DeleteAccountRequestBody

Defined in StripeAPI.Operations.DeleteAccount

Methods

parseJSON :: Value -> Parser DeleteAccountRequestBody

parseJSONList :: Value -> Parser [DeleteAccountRequestBody]

data DeleteAccountResponse

Represents a response of the operation deleteAccount.

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

Constructors

DeleteAccountResponseError String

Means either no matching case available or a parse error

DeleteAccountResponse200 DeletedAccount

Successful response.

DeleteAccountResponseDefault Error

Error response.

Instances

Eq DeleteAccountResponse

Defined in StripeAPI.Operations.DeleteAccount

Methods

(==) :: DeleteAccountResponse -> DeleteAccountResponse -> Bool

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

Show DeleteAccountResponse

Defined in StripeAPI.Operations.DeleteAccount

Methods

showsPrec :: Int -> DeleteAccountResponse -> ShowS

show :: DeleteAccountResponse -> String

showList :: [DeleteAccountResponse] -> ShowS