PayNow

SaleDto

Represents a detailed view of a Sale, including configuration and audit information.

idFlakeIdRequired
apply_to_product_idsFlakeId[]Required
A list of product IDs the sale applies to.
apply_to_tag_idsFlakeId[]Required
A list of tag IDs the sale applies to.
begins_atstringRequired
The date and time when the sale begins.
created_atstringRequired
The date and time when the sale was created.
created_byActorDtoRequired
Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.
idFlakeIdOptional
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
discount_amountintegerRequired
The discount value. For percent discounts, this represents the percentage multiplied by 10 (e.g., 250 = 25%). For amount discounts, this represents the value in the smallest currency unit (e.g., cents).
discount_typeenumRequired
Possible enum values
  • percent
  • amount
durationenumRequired
Possible enum values
  • unspecified
  • once
  • forever
  • repeating
duration_in_intervalsintegerRequired
The number of subscription intervals the coupon is valid for, used if the duration is repeating.
enabledbooleanRequired
Indicates whether the sale is enabled.
minimum_order_valueintegerRequired
The minimum order value required to apply the sale, in the smallest currency unit (e.g., cents).
namestringRequired
The name of the sale.
store_idFlakeIdRequired
version_idFlakeIdRequired
ends_atstringOptional
The date and time when the sale ends.
updated_atstringOptional
The date and time when the sale was last updated.
updated_byActorDtoOptional
Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.
idFlakeIdOptional
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
Example
{
  "id": "411486491630370816",
  "apply_to_product_ids": [
    "411486491630370816"
  ],
  "apply_to_tag_ids": [
    "411486491630370816"
  ],
  "begins_at": "2024-01-01T00:00:00Z",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "discount_amount": 0,
  "discount_type": "percent",
  "duration": "unspecified",
  "duration_in_intervals": 0,
  "enabled": true,
  "minimum_order_value": 0,
  "name": "string",
  "store_id": "411486491630370816",
  "version_id": "411486491630370816",
  "ends_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  }
}