StripeAPI.Operations.PostCoupons

Contains the different functions to run the operation postCoupons

Documentation

postCoupons

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> PostCouponsRequestBody

The request body to send

-> m (Either HttpException (Response PostCouponsResponse))

Monad containing the result of the operation

POST /v1/coupons

<p>You can create coupons easily via the <a href="https://dashboard.stripe.com/coupons">coupon management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.</p>

<p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of <currency>100</currency> will have a final total of <currency>0</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it and an invoice with a subtotal of <currency>300</currency> will have a final total of <currency>100</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it.</p>

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

POST /v1/coupons

The same as postCoupons but returns the raw ByteString

postCouponsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCouponsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCouponsResponse))

POST /v1/coupons

Monadic version of postCoupons (use with runWithConfiguration)

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

POST /v1/coupons

Monadic version of postCouponsRaw (use with runWithConfiguration)

data PostCouponsRequestBody

Defines the data type for the schema postCouponsRequestBody

Constructors

PostCouponsRequestBody

Fields

• postCouponsRequestBodyAmountOff :: Maybe Integer

  amount_off: A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).

• postCouponsRequestBodyCurrency :: Maybe Text

  currency: Three-letter ISO code for the currency of the `amount_off` parameter (required if `amount_off` is passed).

• postCouponsRequestBodyDuration :: PostCouponsRequestBodyDuration'

  duration: Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`.

  Constraints:

  • Maximum length of 5000
• postCouponsRequestBodyDurationInMonths :: Maybe Integer

  duration_in_months: Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.

• postCouponsRequestBodyExpand :: Maybe ([] Text)

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

• postCouponsRequestBodyId :: Maybe Text

  id: Unique string of your choice that will be used to identify this coupon when applying it to a customer. This is often a specific code you'll give to your customer to use when signing up (e.g., `FALL25OFF`). If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.

  Constraints:

  • Maximum length of 5000
• postCouponsRequestBodyMaxRedemptions :: Maybe Integer

  max_redemptions: A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.

• postCouponsRequestBodyMetadata :: Maybe PostCouponsRequestBodyMetadata'

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

• postCouponsRequestBodyName :: 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
• postCouponsRequestBodyPercentOff :: Maybe Double

  percent_off: A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).

• postCouponsRequestBodyRedeemBy :: Maybe Integer

  redeem_by: Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.

Instances

Eq PostCouponsRequestBody

Defined in StripeAPI.Operations.PostCoupons

Methods

(==) :: PostCouponsRequestBody -> PostCouponsRequestBody -> Bool

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

Show PostCouponsRequestBody

Defined in StripeAPI.Operations.PostCoupons

Methods

showsPrec :: Int -> PostCouponsRequestBody -> ShowS

show :: PostCouponsRequestBody -> String

showList :: [PostCouponsRequestBody] -> ShowS

ToJSON PostCouponsRequestBody

Defined in StripeAPI.Operations.PostCoupons

Methods

toJSON :: PostCouponsRequestBody -> Value

toEncoding :: PostCouponsRequestBody -> Encoding

toJSONList :: [PostCouponsRequestBody] -> Value

toEncodingList :: [PostCouponsRequestBody] -> Encoding

FromJSON PostCouponsRequestBody

Defined in StripeAPI.Operations.PostCoupons

Methods

parseJSON :: Value -> Parser PostCouponsRequestBody

parseJSONList :: Value -> Parser [PostCouponsRequestBody]

data PostCouponsRequestBodyDuration'

Defines the enum schema postCouponsRequestBodyDuration'

Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`.

Constructors

PostCouponsRequestBodyDuration'EnumOther Value

PostCouponsRequestBodyDuration'EnumTyped Text

PostCouponsRequestBodyDuration'EnumStringForever

PostCouponsRequestBodyDuration'EnumStringOnce

PostCouponsRequestBodyDuration'EnumStringRepeating

Instances

Eq PostCouponsRequestBodyDuration'

Defined in StripeAPI.Operations.PostCoupons

Methods

(==) :: PostCouponsRequestBodyDuration' -> PostCouponsRequestBodyDuration' -> Bool

(/=) :: PostCouponsRequestBodyDuration' -> PostCouponsRequestBodyDuration' -> Bool

Show PostCouponsRequestBodyDuration'

Defined in StripeAPI.Operations.PostCoupons

Methods

showsPrec :: Int -> PostCouponsRequestBodyDuration' -> ShowS

show :: PostCouponsRequestBodyDuration' -> String

showList :: [PostCouponsRequestBodyDuration'] -> ShowS

ToJSON PostCouponsRequestBodyDuration'

Defined in StripeAPI.Operations.PostCoupons

Methods

toJSON :: PostCouponsRequestBodyDuration' -> Value

toEncoding :: PostCouponsRequestBodyDuration' -> Encoding

toJSONList :: [PostCouponsRequestBodyDuration'] -> Value

toEncodingList :: [PostCouponsRequestBodyDuration'] -> Encoding

FromJSON PostCouponsRequestBodyDuration'

Defined in StripeAPI.Operations.PostCoupons

Methods

parseJSON :: Value -> Parser PostCouponsRequestBodyDuration'

parseJSONList :: Value -> Parser [PostCouponsRequestBodyDuration']

data PostCouponsRequestBodyMetadata'

Defines the data type for the schema postCouponsRequestBodyMetadata'

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

PostCouponsRequestBodyMetadata'

Instances

Eq PostCouponsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCoupons

Methods

(==) :: PostCouponsRequestBodyMetadata' -> PostCouponsRequestBodyMetadata' -> Bool

(/=) :: PostCouponsRequestBodyMetadata' -> PostCouponsRequestBodyMetadata' -> Bool

Show PostCouponsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCoupons

Methods

showsPrec :: Int -> PostCouponsRequestBodyMetadata' -> ShowS

show :: PostCouponsRequestBodyMetadata' -> String

showList :: [PostCouponsRequestBodyMetadata'] -> ShowS

ToJSON PostCouponsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCoupons

Methods

toJSON :: PostCouponsRequestBodyMetadata' -> Value

toEncoding :: PostCouponsRequestBodyMetadata' -> Encoding

toJSONList :: [PostCouponsRequestBodyMetadata'] -> Value

toEncodingList :: [PostCouponsRequestBodyMetadata'] -> Encoding

FromJSON PostCouponsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCoupons

Methods

parseJSON :: Value -> Parser PostCouponsRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostCouponsRequestBodyMetadata']

data PostCouponsResponse

Represents a response of the operation postCoupons.

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

Constructors

PostCouponsResponseError String

Means either no matching case available or a parse error

PostCouponsResponse200 Coupon

Successful response.

PostCouponsResponseDefault Error

Error response.

Instances

Eq PostCouponsResponse

Defined in StripeAPI.Operations.PostCoupons

Methods

(==) :: PostCouponsResponse -> PostCouponsResponse -> Bool

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

Show PostCouponsResponse

Defined in StripeAPI.Operations.PostCoupons

Methods

showsPrec :: Int -> PostCouponsResponse -> ShowS

show :: PostCouponsResponse -> String

showList :: [PostCouponsResponse] -> ShowS