StripeAPI.Operations.PostCouponsCoupon

Contains the different functions to run the operation postCouponsCoupon

Documentation

postCouponsCoupon

Arguments

:: forall m. MonadHTTP m

=> Text

coupon | Constraints: Maximum length of 5000

-> Maybe PostCouponsCouponRequestBody

The request body to send

-> ClientT m (Response PostCouponsCouponResponse)

Monadic computation which returns the result of the operation

POST /v1/coupons/{coupon}

<p>Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.</p>

data PostCouponsCouponRequestBody

Defines the object schema located at paths./v1/coupons/{coupon}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostCouponsCouponRequestBody

Fields

• postCouponsCouponRequestBodyExpand :: Maybe [Text]

  expand: Specifies which fields in the response should be expanded.

• postCouponsCouponRequestBodyMetadata :: Maybe PostCouponsCouponRequestBodyMetadata'Variants

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

• postCouponsCouponRequestBodyName :: Maybe Text

  name: Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.

  Constraints:

  • Maximum length of 40

Instances

Eq PostCouponsCouponRequestBody

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

(==) :: PostCouponsCouponRequestBody -> PostCouponsCouponRequestBody -> Bool

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

Show PostCouponsCouponRequestBody

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

showsPrec :: Int -> PostCouponsCouponRequestBody -> ShowS

show :: PostCouponsCouponRequestBody -> String

showList :: [PostCouponsCouponRequestBody] -> ShowS

ToJSON PostCouponsCouponRequestBody

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

toJSON :: PostCouponsCouponRequestBody -> Value

toEncoding :: PostCouponsCouponRequestBody -> Encoding

toJSONList :: [PostCouponsCouponRequestBody] -> Value

toEncodingList :: [PostCouponsCouponRequestBody] -> Encoding

FromJSON PostCouponsCouponRequestBody

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

parseJSON :: Value -> Parser PostCouponsCouponRequestBody

parseJSONList :: Value -> Parser [PostCouponsCouponRequestBody]

mkPostCouponsCouponRequestBody :: PostCouponsCouponRequestBody

Create a new PostCouponsCouponRequestBody with all required fields.

data PostCouponsCouponRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/coupons/{coupon}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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

Constructors

PostCouponsCouponRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostCouponsCouponRequestBodyMetadata'Object Object

Instances

Eq PostCouponsCouponRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

(==) :: PostCouponsCouponRequestBodyMetadata'Variants -> PostCouponsCouponRequestBodyMetadata'Variants -> Bool

(/=) :: PostCouponsCouponRequestBodyMetadata'Variants -> PostCouponsCouponRequestBodyMetadata'Variants -> Bool

Show PostCouponsCouponRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

showsPrec :: Int -> PostCouponsCouponRequestBodyMetadata'Variants -> ShowS

show :: PostCouponsCouponRequestBodyMetadata'Variants -> String

showList :: [PostCouponsCouponRequestBodyMetadata'Variants] -> ShowS

ToJSON PostCouponsCouponRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

toJSON :: PostCouponsCouponRequestBodyMetadata'Variants -> Value

toEncoding :: PostCouponsCouponRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostCouponsCouponRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostCouponsCouponRequestBodyMetadata'Variants] -> Encoding

FromJSON PostCouponsCouponRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

parseJSON :: Value -> Parser PostCouponsCouponRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostCouponsCouponRequestBodyMetadata'Variants]

data PostCouponsCouponResponse

Represents a response of the operation postCouponsCoupon.

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

Constructors

PostCouponsCouponResponseError String

Means either no matching case available or a parse error

PostCouponsCouponResponse200 Coupon

Successful response.

PostCouponsCouponResponseDefault Error

Error response.

Instances

Eq PostCouponsCouponResponse

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

(==) :: PostCouponsCouponResponse -> PostCouponsCouponResponse -> Bool

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

Show PostCouponsCouponResponse

Defined in StripeAPI.Operations.PostCouponsCoupon

Methods

showsPrec :: Int -> PostCouponsCouponResponse -> ShowS

show :: PostCouponsCouponResponse -> String

showList :: [PostCouponsCouponResponse] -> ShowS