StripeAPI.Types.PromotionCode · stripeapi-3.0.0.0

datadata 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
- 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 subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.
- promotionCodeCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- promotionCodeCustomer :: Maybe (Nullable PromotionCodeCustomer'NonNullableVariants)
  customer: The customer that this promotion code can be used by.
- promotionCodeExpiresAt :: Maybe (Nullable 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 (Nullable Int)
  max_redemptions: Maximum number of times this promotion code can be redeemed.
- promotionCodeMetadata :: Maybe (Nullable 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.

Instances4Eq, Show, FromJSON, ToJSON

Eq PromotionCodeDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PromotionCode
Show PromotionCodeDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PromotionCode
FromJSON PromotionCodeDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PromotionCode
ToJSON PromotionCodeDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PromotionCode

valuemkPromotionCode

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

datadata PromotionCodeCustomer'NonNullableVariants

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'NonNullableText Text
PromotionCodeCustomer'NonNullableCustomer Customer
PromotionCodeCustomer'NonNullableDeletedCustomer DeletedCustomer

Instances4Eq, Show, FromJSON, ToJSON

Eq PromotionCodeCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PromotionCode
Show PromotionCodeCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PromotionCode
FromJSON PromotionCodeCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PromotionCode
ToJSON PromotionCodeCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PromotionCode