MarketingCouponConfigurationDto

Represents the configuration settings for a coupon applied to marketing features.

customer_redeem_limitintegerRequired

Gets or sets the maximum number of times a single customer can redeem the coupon.

customer_redeem_limit_enabledbooleanRequired

Gets or sets a value indicating whether a customer-specific redeem limit is enabled.

discount_amountintegerRequired

Gets or sets the discount amount.

discount_apply_before_salesbooleanRequired

Gets or sets a value indicating whether the discount is applied before any existing sales or discounts.

discount_only_required_tags_or_productsbooleanRequired

Gets or sets a value indicating whether the discount only applies to specific tags or products.

discount_typeenumRequired

Specifies the type of discount applied by a coupon.

Possible enum values

unspecified
No discount type specified. This value is typically used as a default or uninitialized state.
percent
A percentage-based discount (e.g., 10% off).
amount
A fixed amount discount (e.g., $5 off).

durationenumRequired

Defines the duration for which a coupon remains valid.

Possible enum values

once
The coupon can be used only once.
forever
The coupon remains valid indefinitely (no expiration).
repeating
The coupon is valid for a repeating period, typically specified in months.

minimum_order_valueintegerRequired

Gets or sets the minimum order value required for the discount to be applied.

required_product_idsFlakeId[]Required

Gets or sets the list of product IDs required for the discount to apply.

required_tag_idsFlakeId[]Required

Gets or sets the list of tag IDs required for the discount to apply.

usable_on_one_time_purchasesbooleanRequired

Gets or sets a value indicating whether the coupon can be used on one-time purchases.

usable_on_subscriptionsbooleanRequired

Gets or sets a value indicating whether the coupon can be used on subscription purchases.

duration_in_intervalsintegerOptional

Gets or sets the duration of the coupon in intervals, applicable only for repeating coupons.

expires_afterPeriodOptional

ISO 8601 duration format

Example

{
  "customer_redeem_limit": 0,
  "customer_redeem_limit_enabled": true,
  "discount_amount": 0,
  "discount_apply_before_sales": true,
  "discount_only_required_tags_or_products": true,
  "discount_type": "unspecified",
  "duration": "once",
  "minimum_order_value": 0,
  "required_product_ids": [
    "411486491630370816"
  ],
  "required_tag_ids": [
    "411486491630370816"
  ],
  "usable_on_one_time_purchases": true,
  "usable_on_subscriptions": true,
  "duration_in_intervals": 0,
  "expires_after": "P1Y2M3DT4H5M6S"
}