stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.DeleteCouponsCoupon

Description

Contains the different functions to run the operation deleteCouponsCoupon

Synopsis

Documentation

deleteCouponsCoupon Source #

Arguments

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

The configuration to use in the request

-> String

coupon | Constraints: Maximum length of 5000

-> DeleteCouponsCouponRequestBody

The request body to send

-> m (Either HttpException (Response DeleteCouponsCouponResponse))

Monad containing the result of the operation

DELETE /v1/coupons/{coupon}

<p>You can delete coupons via the <a href="https://dashboard.stripe.com/coupons">coupon management</a> page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.</p>

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

DELETE /v1/coupons/{coupon}

The same as deleteCouponsCoupon but returns the raw ByteString

data DeleteCouponsCouponResponse Source #

Represents a response of the operation deleteCouponsCoupon.

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

Constructors

DeleteCouponsCouponResponseError String

Means either no matching case available or a parse error

DeleteCouponsCouponResponse200 DeletedCoupon

Successful response.

DeleteCouponsCouponResponseDefault Error

Error response.