StripeAPI.Types.Discount

Contains the types generated from the schema Discount

Documentation

data Discount

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

A discount represents the actual application of a coupon to a particular customer. It contains information about when the discount began and when it will end.

Related guide: Applying Discounts to Subscriptions.

Constructors

Discount

Fields

• discountCheckoutSession :: Maybe Text

  checkout_session: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

  Constraints:

  • Maximum length of 5000
• discountCoupon :: 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.

• discountCustomer :: Maybe DiscountCustomer'Variants

  customer: The ID of the customer associated with this discount.

• discountEnd :: Maybe Int

  end: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.

• discountId :: Text

  id: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.

  Constraints:

  • Maximum length of 5000
• discountInvoice :: Maybe Text

  invoice: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.

  Constraints:

  • Maximum length of 5000
• discountInvoiceItem :: Maybe Text

  invoice_item: The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

  Constraints:

  • Maximum length of 5000
• discountPromotionCode :: Maybe DiscountPromotionCode'Variants

  promotion_code: The promotion code applied to create this discount.

• discountStart :: Int

  start: Date that the coupon was applied.

• discountSubscription :: Maybe Text

  subscription: The subscription that this coupon is applied to, if it is applied to a particular subscription.

  Constraints:

  • Maximum length of 5000

Instances

Eq Discount

Defined in StripeAPI.Types.Discount

Methods

(==) :: Discount -> Discount -> Bool

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

Show Discount

Defined in StripeAPI.Types.Discount

Methods

showsPrec :: Int -> Discount -> ShowS

show :: Discount -> String

showList :: [Discount] -> ShowS

ToJSON Discount

Defined in StripeAPI.Types.Discount

Methods

toJSON :: Discount -> Value

toEncoding :: Discount -> Encoding

toJSONList :: [Discount] -> Value

toEncodingList :: [Discount] -> Encoding

FromJSON Discount

Defined in StripeAPI.Types.Discount

Methods

parseJSON :: Value -> Parser Discount

parseJSONList :: Value -> Parser [Discount]

mkDiscount

Arguments

:: Coupon

discountCoupon

-> Text

discountId

-> Int

discountStart

-> Discount

Create a new Discount with all required fields.

data DiscountCustomer'Variants

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

The ID of the customer associated with this discount.

Constructors

DiscountCustomer'Text Text

DiscountCustomer'Customer Customer

DiscountCustomer'DeletedCustomer DeletedCustomer

Instances

Eq DiscountCustomer'Variants

Defined in StripeAPI.Types.Discount

Methods

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

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

Show DiscountCustomer'Variants

Defined in StripeAPI.Types.Discount

Methods

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

show :: DiscountCustomer'Variants -> String

showList :: [DiscountCustomer'Variants] -> ShowS

ToJSON DiscountCustomer'Variants

Defined in StripeAPI.Types.Discount

Methods

toJSON :: DiscountCustomer'Variants -> Value

toEncoding :: DiscountCustomer'Variants -> Encoding

toJSONList :: [DiscountCustomer'Variants] -> Value

toEncodingList :: [DiscountCustomer'Variants] -> Encoding

FromJSON DiscountCustomer'Variants

Defined in StripeAPI.Types.Discount

Methods

parseJSON :: Value -> Parser DiscountCustomer'Variants

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

data DiscountPromotionCode'Variants

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

The promotion code applied to create this discount.

Constructors

DiscountPromotionCode'Text Text

DiscountPromotionCode'PromotionCode PromotionCode

Instances

Eq DiscountPromotionCode'Variants

Defined in StripeAPI.Types.Discount

Methods

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

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

Show DiscountPromotionCode'Variants

Defined in StripeAPI.Types.Discount

Methods

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

show :: DiscountPromotionCode'Variants -> String

showList :: [DiscountPromotionCode'Variants] -> ShowS

ToJSON DiscountPromotionCode'Variants

Defined in StripeAPI.Types.Discount

Methods

toJSON :: DiscountPromotionCode'Variants -> Value

toEncoding :: DiscountPromotionCode'Variants -> Encoding

toJSONList :: [DiscountPromotionCode'Variants] -> Value

toEncodingList :: [DiscountPromotionCode'Variants] -> Encoding

FromJSON DiscountPromotionCode'Variants

Defined in StripeAPI.Types.Discount

Methods

parseJSON :: Value -> Parser DiscountPromotionCode'Variants

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