PromotionDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A promotion as read back over the API and rendered in the administrative grid.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
extraProperties
required |
object |
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
id
required |
string (uuid) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
creationTime
required |
string (date-time) | The date and time when this entity was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
creatorId
required |
string (uuid) | The ID of the user who created this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
lastModificationTime
required |
string (date-time) | The date and time when this entity was last modified.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
lastModifierId
required |
string (uuid) | The ID of the user who last modified this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isDeleted
required |
boolean | Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
deleterId
required |
string (uuid) | The ID of the user who deleted this entity, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
deletionTime
required |
string (date-time) | The date and time when this entity was deleted, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
merchantId
required |
string (uuid) | The merchant that owns this promotion.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
code
required |
string | The code a payer types, in its stored normalized form.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
name
required |
string | Operator-facing promotion name.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
description
required |
string | Free-text description of the promotion.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
discountType
required |
PromotionDiscountType PromotionDiscountType | Whether the value is a percentage or a flat amount.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
value
required |
number (double) | The percentage, or the flat amount in `currency`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
currency
required |
string | The ISO 4217 currency, when the promotion is pinned to one.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
startsAtUtc
required |
string (date-time) | UTC moment the promotion starts being accepted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
endsAtUtc
required |
string (date-time) | UTC moment the promotion stops being accepted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
maxRedemptions
required |
integer (int32) | How many times the promotion may be redeemed in total.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
maxRedemptionsPerCustomer
required |
integer (int32) | How many times one customer may redeem it.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
minimumSubtotal
required |
number (double) | The smallest amount the promotion applies to.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
redemptionCount
required |
integer (int32) | How many times the promotion has been redeemed.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
remainingRedemptions
required |
integer (int32) | How many redemptions remain before the total ceiling, or `null` when there is no ceiling.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
appliesToScope
required |
PromotionAppliesToScope PromotionAppliesToScope | What the promotion may be applied to.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
appliesToTargetIds
required |
array of string (uuid) array of | The pages, products or plans the scope names.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
durationMode
required |
PromotionDurationMode PromotionDurationMode | How long the discount runs on a recurring charge.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
durationCycles
required |
integer (int32) | How many billing cycles the discount runs for, when the duration counts cycles.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isActive
required |
boolean | Whether the promotion is accepted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isRedeemable
required |
boolean | Whether the promotion would be accepted right now: active, inside its window, and with
redemptions left. It says nothing about any particular order, which only an evaluation
against a real amount and target can answer.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
concurrencyStamp
required |
string | Optimistic concurrency token.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.