PayNow

Trials

Get trials for a store

GEThttps://api.paynow.gg/v1/stores/{storeId}/trials

Retrieves all trials for the specified store.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store to retrieve trials for.
Query parameters
statusenum[]Optional
Filters trials by their status. Multiple statuses can be specified.
customer_idFlakeIdOptional
Filters trials by the customer identifier.
subscription_idFlakeIdOptional
Filters trials by the associated subscription identifier.
checkout_idFlakeIdOptional
Filters trials by the checkout session identifier that initiated them.
trial_idFlakeIdOptional
Filters to a specific trial by its identifier.
limitintegerOptional
The maximum number of items to return in a single request.
afterFlakeIdOptional
Returns items after the specified ID. Used for forward pagination through results.
beforeFlakeIdOptional
Returns items before the specified ID. Used for backward pagination through results.
ascbooleanOptional
Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
Response
200OKTrialDto[]
Show fields
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.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/trials" \
  -H "Authorization: APIKey TOKEN"
Response200
[
  {
    "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"
  }
]

Get a trial by ID for a store

GEThttps://api.paynow.gg/v1/stores/{storeId}/trials/{trialId}

Retrieves a trial by the ID for the specified store.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store to retrieve the trial for.
trialIdFlakeIdRequired
The ID of the trial.
Response
200OKTrialDto
Show fields
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.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/trials/{trialId}" \
  -H "Authorization: APIKey TOKEN"
Response200
{
  "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"
}

Get trial eligibility overrides for a specific customer

GEThttps://api.paynow.gg/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides

Retrieves all trial eligibility overrides for the specified customer.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store to retrieve trial eligibility overrides for.
customerIdFlakeIdRequired
The ID of the customer to retrieve trial eligibility overrides for.
Query parameters
limitintegerOptional
The maximum number of items to return in a single request.
afterFlakeIdOptional
Returns items after the specified ID. Used for forward pagination through results.
beforeFlakeIdOptional
Returns items before the specified ID. Used for backward pagination through results.
ascbooleanOptional
Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
Response
200OKTrialEligibilityOverrideDto[]
Show fields
idFlakeIdRequired
created_atstringRequired
The date and time when this override 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
customer_idFlakeIdRequired
expires_atstringRequired
The date and time when this override expires and is no longer valid.
pretty_idstringRequired
The human-readable formatted version of the override identifier.
product_idFlakeIdRequired
product_namestringRequired
The name of the product associated with this override.
store_idFlakeIdRequired
deleted_atstringOptional
The date and time when this override was deleted, if applicable.
deleted_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
notestringOptional
An optional note or comment about this override.
product_image_urlstringOptional
The URL of the product image, if available.
used_atstringOptional
The date and time when this override was used to start a trial, if applicable.
used_on_trial_idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides" \
  -H "Authorization: APIKey TOKEN"
Response200
[
  {
    "id": "411486491630370816",
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "customer_id": "411486491630370816",
    "expires_at": "2024-01-01T00:00:00Z",
    "pretty_id": "string",
    "product_id": "411486491630370816",
    "product_name": "string",
    "store_id": "411486491630370816",
    "deleted_at": "2024-01-01T00:00:00Z",
    "deleted_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "note": "string",
    "product_image_url": "string",
    "used_at": "2024-01-01T00:00:00Z",
    "used_on_trial_id": "411486491630370816"
  }
]

Create trial eligibility override for a customer

POSThttps://api.paynow.gg/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides

Creates a new trial eligibility override for the specified customer.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store to create the trial eligibility override for.
customerIdFlakeIdRequired
The ID of the customer to create the trial eligibility override for.
Request body
expires_atstringRequired
The date and time when this override expires and is no longer valid.
product_idFlakeIdRequired
notestringOptional
An optional note or comment about this override.
Response
200OKTrialEligibilityOverrideDto
Show fields
idFlakeIdRequired
created_atstringRequired
The date and time when this override 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
customer_idFlakeIdRequired
expires_atstringRequired
The date and time when this override expires and is no longer valid.
pretty_idstringRequired
The human-readable formatted version of the override identifier.
product_idFlakeIdRequired
product_namestringRequired
The name of the product associated with this override.
store_idFlakeIdRequired
deleted_atstringOptional
The date and time when this override was deleted, if applicable.
deleted_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
notestringOptional
An optional note or comment about this override.
product_image_urlstringOptional
The URL of the product image, if available.
used_atstringOptional
The date and time when this override was used to start a trial, if applicable.
used_on_trial_idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "expires_at": "2024-01-01T00:00:00Z",
  "product_id": "411486491630370816",
  "note": "string"
}'
Response200
{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "customer_id": "411486491630370816",
  "expires_at": "2024-01-01T00:00:00Z",
  "pretty_id": "string",
  "product_id": "411486491630370816",
  "product_name": "string",
  "store_id": "411486491630370816",
  "deleted_at": "2024-01-01T00:00:00Z",
  "deleted_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "note": "string",
  "product_image_url": "string",
  "used_at": "2024-01-01T00:00:00Z",
  "used_on_trial_id": "411486491630370816"
}

Delete trial eligibility override for a customer

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides/{trialEligibilityOverrideId}

Deletes an existing trial eligibility override.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store to delete the trial eligibility override for.
trialEligibilityOverrideIdFlakeIdRequired
The ID of the trial eligibility override to delete.
customerIdstringRequired
Response
204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides/{trialEligibilityOverrideId}" \
  -H "Authorization: APIKey TOKEN"