PayNow

TrialDto

idFlakeIdRequired
created_atstringRequired
The date and time when the trial was created.
customerCustomerDtoRequired
Represents a customer in the PayNow system with their associated profiles and metadata.
idFlakeIdRequired
created_atstringRequired
The date and time when the customer was created in the system.
metadataobjectRequired
Additional custom data associated with the customer.
store_idFlakeIdRequired
minecraftCustomerMinecraftProfileDtoOptional
Represents a Minecraft profile for a customer.
idstringRequired
The UUID of the Minecraft player. If the platform is Minecraft Offline, this will be the name itself. If the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID.
avatar_urlstringRequired
The URL to the player's Minecraft skin rendered as an avatar.
namestringRequired
The username of the Minecraft player.
minecraft_platformenumOptional
Possible enum values
  • unknown
  • java
  • bedrock
minecraft_uuidstringOptional
The customer's Minecraft UUID, if they have linked their Minecraft account. Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser, and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.
namestringOptional
The display name for the customer.
profileCustomerGenericProfileDtoOptional
Represents a generic platform profile for a customer.
idstringRequired
The platform-specific identifier for the profile.
namestringRequired
The display name of the user on this platform.
platformstringRequired
The name of the platform this profile belongs to.
avatar_urlstringOptional
The URL to the user's avatar image on this platform.
steamCustomerSteamProfileDtoOptional
Represents a Steam profile for a customer.
idSteamIdRequired
A 64-bit Steam account identifier. Accepts string or numeric format.
avatar_urlstringRequired
The URL to the user's Steam avatar image.
namestringRequired
The display name of the user on Steam.
steam_idSteamIdOptional
A 64-bit Steam account identifier. Accepts string or numeric format.
updated_atstringOptional
The date and time when the customer was last updated, if applicable.
xbox_xuidstringOptional
The customer's Xbox XUID, if available.
customer_idFlakeIdRequired
period_scalestringRequired
The timescale unit for the trial period (e.g., "days", "weeks", "months").
period_valueintegerRequired
The duration value of the trial period.
pretty_idstringRequired
The human-readable formatted version of the trial identifier.
product_idFlakeIdRequired
product_namestringRequired
The name of the product being trialed.
product_version_idFlakeIdRequired
statusenumRequired
Possible enum values
  • created

    The trial has been created but is not yet active.

  • active

    The trial is currently active.

  • canceled

    The trial has been canceled.

  • completed

    The trial has been completed.

store_idFlakeIdRequired
canceled_atstringOptional
The date and time when the trial was canceled, if applicable.
canceled_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
checkout_idFlakeIdOptional
checkout_line_idFlakeIdOptional
ends_atstringOptional
The date and time when the trial period ends, if applicable.
product_image_urlstringOptional
The URL of the product image, if available.
starts_atstringOptional
The date and time when the trial period starts, if applicable.
Example
{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "customer": {
    "id": "411486491630370816",
    "created_at": "2024-01-01T00:00:00Z",
    "metadata": {},
    "store_id": "411486491630370816",
    "minecraft": {
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "avatar_url": "string",
      "name": "notch"
    },
    "minecraft_platform": "unknown",
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "name": "m0uka",
    "profile": {
      "id": "string",
      "name": "string",
      "platform": "steam",
      "avatar_url": "string"
    },
    "steam": {
      "id": "76561197960287930",
      "avatar_url": "string",
      "name": "string"
    },
    "steam_id": "76561197960287930",
    "updated_at": "2024-01-01T00:00:00Z",
    "xbox_xuid": "string"
  },
  "customer_id": "411486491630370816",
  "period_scale": "string",
  "period_value": 0,
  "pretty_id": "string",
  "product_id": "411486491630370816",
  "product_name": "string",
  "product_version_id": "411486491630370816",
  "status": "created",
  "store_id": "411486491630370816",
  "canceled_at": "2024-01-01T00:00:00Z",
  "canceled_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "checkout_id": "411486491630370816",
  "checkout_line_id": "411486491630370816",
  "ends_at": "2024-01-01T00:00:00Z",
  "product_image_url": "string",
  "starts_at": "2024-01-01T00:00:00Z"
}