API Docs / Schemas / DiscountCodeDto

DiscountCodeDto

Response DTO for a discount code (admin view).

Properties

Name Type Description
codestring

The user-facing discount code (e.g. "LAUNCH50").

The user-facing discount code (e.g. "LAUNCH50").

descriptionstring

Admin-facing description of the discount code.

Admin-facing description of the discount code.

discountPercentinteger

The percentage discount to apply (1–100).

The percentage discount to apply (1–100).

durationMonthsinteger

How many months the discount lasts from the date of redemption. Null means permanent.

How many months the discount lasts from the date of redemption. Null means permanent.

maxUsesinteger

Maximum number of times this code can be redeemed. Null means unlimited.

Maximum number of times this code can be redeemed. Null means unlimited.

useCountinteger

Current number of times this code has been redeemed.

Current number of times this code has been redeemed.

validFromstring

When the code becomes redeemable.

When the code becomes redeemable.

validTostring

When the code stops being redeemable. Null means no expiry.

When the code stops being redeemable. Null means no expiry.

packageCodeAndNameDto
isArchivedboolean

When true, the code is disabled and cannot be redeemed.

When true, the code is disabled and cannot be redeemed.

JSON Example

{
  "code": "string",
  "description": "string",
  "discountPercent": 0,
  "durationMonths": 0,
  "maxUses": 0
}

Contained in Schemas