StripeAPI.Types.PromotionCode

Contains the types generated from the schema PromotionCode

Documentation

data PromotionCode

Defines the object schema located at components.schemas.promotion_code in the specification.

A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.

Constructors

PromotionCode

Fields

• promotionCodeActive :: Bool

  active: Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.

• promotionCodeCode :: Text

  code: The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.

  Constraints:

  • Maximum length of 5000
• promotionCodeCoupon :: Coupon

  coupon: A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to invoices or orders. Coupons do not work with conventional one-off charges.

• promotionCodeCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• promotionCodeCustomer :: Maybe PromotionCodeCustomer'Variants

  customer: The customer that this promotion code can be used by.

• promotionCodeExpiresAt :: Maybe Int

  expires_at: Date at which the promotion code can no longer be redeemed.

• promotionCodeId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• promotionCodeLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• promotionCodeMaxRedemptions :: Maybe Int

  max_redemptions: Maximum number of times this promotion code can be redeemed.

• promotionCodeMetadata :: 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.

• promotionCodeRestrictions :: PromotionCodesResourceRestrictions

  restrictions:

• promotionCodeTimesRedeemed :: Int

  times_redeemed: Number of times this promotion code has been used.

Instances

Eq PromotionCode

Defined in StripeAPI.Types.PromotionCode

Methods

(==) :: PromotionCode -> PromotionCode -> Bool

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

Show PromotionCode

Defined in StripeAPI.Types.PromotionCode

Methods

showsPrec :: Int -> PromotionCode -> ShowS

show :: PromotionCode -> String

showList :: [PromotionCode] -> ShowS

ToJSON PromotionCode

Defined in StripeAPI.Types.PromotionCode

Methods

toJSON :: PromotionCode -> Value

toEncoding :: PromotionCode -> Encoding

toJSONList :: [PromotionCode] -> Value

toEncodingList :: [PromotionCode] -> Encoding

FromJSON PromotionCode

Defined in StripeAPI.Types.PromotionCode

Methods

parseJSON :: Value -> Parser PromotionCode

parseJSONList :: Value -> Parser [PromotionCode]

mkPromotionCode

Arguments

:: Bool

promotionCodeActive

-> Text

promotionCodeCode

-> Coupon

promotionCodeCoupon

-> Int

promotionCodeCreated

-> Text

promotionCodeId

-> Bool

promotionCodeLivemode

-> PromotionCodesResourceRestrictions

promotionCodeRestrictions

-> Int

promotionCodeTimesRedeemed

-> PromotionCode

Create a new PromotionCode with all required fields.

data PromotionCodeCustomer'Variants

Defines the oneOf schema located at components.schemas.promotion_code.properties.customer.anyOf in the specification.

The customer that this promotion code can be used by.

Constructors

PromotionCodeCustomer'Text Text

PromotionCodeCustomer'Customer Customer

PromotionCodeCustomer'DeletedCustomer DeletedCustomer

Instances

Eq PromotionCodeCustomer'Variants

Defined in StripeAPI.Types.PromotionCode

Methods

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

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

Show PromotionCodeCustomer'Variants

Defined in StripeAPI.Types.PromotionCode

Methods

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

show :: PromotionCodeCustomer'Variants -> String

showList :: [PromotionCodeCustomer'Variants] -> ShowS

ToJSON PromotionCodeCustomer'Variants

Defined in StripeAPI.Types.PromotionCode

Methods

toJSON :: PromotionCodeCustomer'Variants -> Value

toEncoding :: PromotionCodeCustomer'Variants -> Encoding

toJSONList :: [PromotionCodeCustomer'Variants] -> Value

toEncodingList :: [PromotionCodeCustomer'Variants] -> Encoding

FromJSON PromotionCodeCustomer'Variants

Defined in StripeAPI.Types.PromotionCode

Methods

parseJSON :: Value -> Parser PromotionCodeCustomer'Variants

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