Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostPromotionCodes

Description

Contains the different functions to run the operation postPromotionCodes

Synopsis

postPromotionCodes :: forall m. MonadHTTP m => PostPromotionCodesRequestBody -> ClientT m (Response PostPromotionCodesResponse)
data PostPromotionCodesRequestBody = PostPromotionCodesRequestBody {
}
mkPostPromotionCodesRequestBody :: Text -> PostPromotionCodesRequestBody
data PostPromotionCodesRequestBodyRestrictions' = PostPromotionCodesRequestBodyRestrictions' {
}
mkPostPromotionCodesRequestBodyRestrictions' :: PostPromotionCodesRequestBodyRestrictions'
data PostPromotionCodesResponse

Documentation

postPromotionCodes Source #

Arguments

:: forall m. MonadHTTP m
=> PostPromotionCodesRequestBody	The request body to send
-> ClientT m (Response PostPromotionCodesResponse)	Monadic computation which returns the result of the operation

POST /v1/promotion_codes

<p>A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.</p>

data PostPromotionCodesRequestBody Source #

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

Constructors

PostPromotionCodesRequestBody

Fields

postPromotionCodesRequestBodyActive :: Maybe Bool
active: Whether the promotion code is currently active.
postPromotionCodesRequestBodyCode :: Maybe Text
code: The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.
Constraints:
- Maximum length of 500
postPromotionCodesRequestBodyCoupon :: Text
coupon: The coupon for this promotion code.
Constraints:
- Maximum length of 5000
postPromotionCodesRequestBodyCustomer :: Maybe Text
customer: The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
Constraints:
- Maximum length of 5000
postPromotionCodesRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postPromotionCodesRequestBodyExpiresAt :: Maybe Int
expires_at: The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.
postPromotionCodesRequestBodyMaxRedemptions :: Maybe Int
max_redemptions: A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.
postPromotionCodesRequestBodyMetadata :: Maybe Object
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`.
postPromotionCodesRequestBodyRestrictions :: Maybe PostPromotionCodesRequestBodyRestrictions'
restrictions: Settings that restrict the redemption of the promotion code.

Instances

Instances details

Eq PostPromotionCodesRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods (==) :: PostPromotionCodesRequestBody -> PostPromotionCodesRequestBody -> Bool # (/=) :: PostPromotionCodesRequestBody -> PostPromotionCodesRequestBody -> Bool #
Show PostPromotionCodesRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods showsPrec :: Int -> PostPromotionCodesRequestBody -> ShowS # show :: PostPromotionCodesRequestBody -> String # showList :: [PostPromotionCodesRequestBody] -> ShowS #
ToJSON PostPromotionCodesRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods toJSON :: PostPromotionCodesRequestBody -> Value # toEncoding :: PostPromotionCodesRequestBody -> Encoding # toJSONList :: [PostPromotionCodesRequestBody] -> Value # toEncodingList :: [PostPromotionCodesRequestBody] -> Encoding #
FromJSON PostPromotionCodesRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods parseJSON :: Value -> Parser PostPromotionCodesRequestBody # parseJSONList :: Value -> Parser [PostPromotionCodesRequestBody] #

mkPostPromotionCodesRequestBody Source #

Arguments

:: Text	`postPromotionCodesRequestBodyCoupon`
-> PostPromotionCodesRequestBody

Create a new PostPromotionCodesRequestBody with all required fields.

data PostPromotionCodesRequestBodyRestrictions' Source #

Defines the object schema located at paths./v1/promotion_codes.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.restrictions in the specification.

Settings that restrict the redemption of the promotion code.

Constructors

PostPromotionCodesRequestBodyRestrictions'
Fields postPromotionCodesRequestBodyRestrictions'FirstTimeTransaction :: Maybe Bool first_time_transaction postPromotionCodesRequestBodyRestrictions'MinimumAmount :: Maybe Int minimum_amount postPromotionCodesRequestBodyRestrictions'MinimumAmountCurrency :: Maybe Text minimum_amount_currency

Instances

Instances details

Eq PostPromotionCodesRequestBodyRestrictions' Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods (==) :: PostPromotionCodesRequestBodyRestrictions' -> PostPromotionCodesRequestBodyRestrictions' -> Bool # (/=) :: PostPromotionCodesRequestBodyRestrictions' -> PostPromotionCodesRequestBodyRestrictions' -> Bool #
Show PostPromotionCodesRequestBodyRestrictions' Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods showsPrec :: Int -> PostPromotionCodesRequestBodyRestrictions' -> ShowS # show :: PostPromotionCodesRequestBodyRestrictions' -> String # showList :: [PostPromotionCodesRequestBodyRestrictions'] -> ShowS #
ToJSON PostPromotionCodesRequestBodyRestrictions' Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods toJSON :: PostPromotionCodesRequestBodyRestrictions' -> Value # toEncoding :: PostPromotionCodesRequestBodyRestrictions' -> Encoding # toJSONList :: [PostPromotionCodesRequestBodyRestrictions'] -> Value # toEncodingList :: [PostPromotionCodesRequestBodyRestrictions'] -> Encoding #
FromJSON PostPromotionCodesRequestBodyRestrictions' Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods parseJSON :: Value -> Parser PostPromotionCodesRequestBodyRestrictions' # parseJSONList :: Value -> Parser [PostPromotionCodesRequestBodyRestrictions'] #

mkPostPromotionCodesRequestBodyRestrictions' :: PostPromotionCodesRequestBodyRestrictions' Source #

Create a new PostPromotionCodesRequestBodyRestrictions' with all required fields.

data PostPromotionCodesResponse Source #

Represents a response of the operation postPromotionCodes.

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

Constructors

PostPromotionCodesResponseError String	Means either no matching case available or a parse error
PostPromotionCodesResponse200 PromotionCode	Successful response.
PostPromotionCodesResponseDefault Error	Error response.

Instances

Instances details

Eq PostPromotionCodesResponse Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods (==) :: PostPromotionCodesResponse -> PostPromotionCodesResponse -> Bool # (/=) :: PostPromotionCodesResponse -> PostPromotionCodesResponse -> Bool #
Show PostPromotionCodesResponse Source #
Instance details Defined in StripeAPI.Operations.PostPromotionCodes Methods showsPrec :: Int -> PostPromotionCodesResponse -> ShowS # show :: PostPromotionCodesResponse -> String # showList :: [PostPromotionCodesResponse] -> ShowS #