StripeAPI.Types.Discount · stripeapi-3.0.0.0

datadata Discount

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

A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.

Related guide: Applying Discounts to Subscriptions.

Constructors

Discount
- discountCheckoutSession :: Maybe (Nullable 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 subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.
- discountCustomer :: Maybe (Nullable DiscountCustomer'NonNullableVariants)
  customer: The ID of the customer associated with this discount.
- discountEnd :: Maybe (Nullable 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 (Nullable 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 (Nullable 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 (Nullable DiscountPromotionCode'NonNullableVariants)
  promotion_code: The promotion code applied to create this discount.
- discountStart :: Int
  start: Date that the coupon was applied.
- discountSubscription :: Maybe (Nullable Text)
  subscription: The subscription that this coupon is applied to, if it is applied to a particular subscription.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq DiscountDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
Show DiscountDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
FromJSON DiscountDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
ToJSON DiscountDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount

valuemkDiscount

:: Coupon
discountCoupon
-> Text
discountId
-> Int
discountStart
-> Discount

Create a new Discount with all required fields.

datadata DiscountCustomer'NonNullableVariants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq DiscountCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
Show DiscountCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
FromJSON DiscountCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
ToJSON DiscountCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount

datadata DiscountPromotionCode'NonNullableVariants

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'NonNullableText Text
DiscountPromotionCode'NonNullablePromotionCode PromotionCode

Instances4Eq, Show, FromJSON, ToJSON

Eq DiscountPromotionCode'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
Show DiscountPromotionCode'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
FromJSON DiscountPromotionCode'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount
ToJSON DiscountPromotionCode'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Discount