StripeAPI.Operations.DeleteCouponsCoupon

Contains the different functions to run the operation deleteCouponsCoupon

Documentation

deleteCouponsCoupon

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Text

coupon | Constraints: Maximum length of 5000

-> Maybe 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 -> Text -> Maybe DeleteCouponsCouponRequestBody -> m (Either HttpException (Response ByteString))

DELETE /v1/coupons/{coupon}

The same as deleteCouponsCoupon but returns the raw ByteString

deleteCouponsCouponM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteCouponsCouponResponse))

DELETE /v1/coupons/{coupon}

Monadic version of deleteCouponsCoupon (use with runWithConfiguration)

deleteCouponsCouponRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteCouponsCouponRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

DELETE /v1/coupons/{coupon}

Monadic version of deleteCouponsCouponRaw (use with runWithConfiguration)

data DeleteCouponsCouponRequestBody

Defines the data type for the schema deleteCouponsCouponRequestBody

Constructors

DeleteCouponsCouponRequestBody

Instances

Eq DeleteCouponsCouponRequestBody

Defined in StripeAPI.Operations.DeleteCouponsCoupon

Methods

(==) :: DeleteCouponsCouponRequestBody -> DeleteCouponsCouponRequestBody -> Bool

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

Show DeleteCouponsCouponRequestBody

Defined in StripeAPI.Operations.DeleteCouponsCoupon

Methods

showsPrec :: Int -> DeleteCouponsCouponRequestBody -> ShowS

show :: DeleteCouponsCouponRequestBody -> String

showList :: [DeleteCouponsCouponRequestBody] -> ShowS

ToJSON DeleteCouponsCouponRequestBody

Defined in StripeAPI.Operations.DeleteCouponsCoupon

Methods

toJSON :: DeleteCouponsCouponRequestBody -> Value

toEncoding :: DeleteCouponsCouponRequestBody -> Encoding

toJSONList :: [DeleteCouponsCouponRequestBody] -> Value

toEncodingList :: [DeleteCouponsCouponRequestBody] -> Encoding

FromJSON DeleteCouponsCouponRequestBody

Defined in StripeAPI.Operations.DeleteCouponsCoupon

Methods

parseJSON :: Value -> Parser DeleteCouponsCouponRequestBody

parseJSONList :: Value -> Parser [DeleteCouponsCouponRequestBody]

data DeleteCouponsCouponResponse

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.

Instances

Eq DeleteCouponsCouponResponse

Defined in StripeAPI.Operations.DeleteCouponsCoupon

Methods

(==) :: DeleteCouponsCouponResponse -> DeleteCouponsCouponResponse -> Bool

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

Show DeleteCouponsCouponResponse

Defined in StripeAPI.Operations.DeleteCouponsCoupon

Methods

showsPrec :: Int -> DeleteCouponsCouponResponse -> ShowS

show :: DeleteCouponsCouponResponse -> String

showList :: [DeleteCouponsCouponResponse] -> ShowS