UpdateCouponDto

apply_to_productsFlakeId[]Optional

apply_to_tagsFlakeId[]Optional

codestringOptional

discount_amountintegerOptional

discount_apply_before_salesbooleanOptional

discount_apply_individuallybooleanOptional

discount_typeenumOptional

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

durationenumOptional

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.

duration_in_intervalsintegerOptional

duration_in_monthsintegerOptional

enabledbooleanOptional

expires_atstringOptional

minimum_order_valueintegerOptional

notestringOptional

redeem_limit_customer_amountintegerOptional

redeem_limit_customer_enabledbooleanOptional

redeem_limit_store_amountintegerOptional

redeem_limit_store_enabledbooleanOptional

usable_atstringOptional

usable_by_customer_idFlakeIdOptional

usable_on_one_time_purchasebooleanOptional

usable_on_subscriptionbooleanOptional

Example

{
  "enabled": true,
  "code": "string",
  "note": "string",
  "duration": "once",
  "duration_in_months": 0,
  "duration_in_intervals": 0,
  "discount_type": "unspecified",
  "discount_amount": 0,
  "discount_apply_individually": true,
  "discount_apply_before_sales": true,
  "apply_to_products": [
    "411486491630370816"
  ],
  "apply_to_tags": [
    "411486491630370816"
  ],
  "usable_by_customer_id": "411486491630370816",
  "minimum_order_value": 0,
  "redeem_limit_store_enabled": true,
  "redeem_limit_store_amount": 0,
  "redeem_limit_customer_enabled": true,
  "redeem_limit_customer_amount": 0,
  "usable_on_one_time_purchase": true,
  "usable_on_subscription": true,
  "usable_at": "2024-01-01T00:00:00Z",
  "expires_at": "2024-01-01T00:00:00Z"
}