Trials

Get trials for a store

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Query parameters

customer_idstring · flake-idOptional

Filters trials by the customer identifier.

Example: 411486491630370816

subscription_idstring · flake-idOptional

Filters trials by the associated subscription identifier.

Example: 411486491630370816

checkout_idstring · flake-idOptional

Filters trials by the checkout session identifier that initiated them.

Example: 411486491630370816

trial_idstring · flake-idOptional

Filters to a specific trial by its identifier.

Example: 411486491630370816

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/trials

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/trials HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "store_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "store": {
        "id": "411486491630370816",
        "trust": {
          "store_id": "411486491630370816",
          "status": "invalid",
          "status_reason": null,
          "restrictions": "none",
          "created_at": "2026-03-10T18:26:45.751Z",
          "updated_at": null,
          "onboarding_steps": {
            "store_id": "411486491630370816",
            "store_owner_id": "411486491630370816",
            "payout_onboarding_completed": true,
            "kyc_completed": true,
            "products_created": true,
            "gameserver_linked": true,
            "webhooks_active": true,
            "downloadable_files_added": true
          },
          "events": [
            {
              "id": "411486491630370816",
              "store_id": "411486491630370816",
              "type": "invalid",
              "description": null,
              "store_requirement_id": "411486491630370816",
              "store_review_id": "411486491630370816",
              "actor": {
                "type": "anonymous",
                "id": "411486491630370816"
              },
              "created_at": "2026-03-10T18:26:45.751Z"
            }
          ],
          "pending_requirements": [
            {
              "id": "411486491630370816",
              "store_id": "411486491630370816",
              "template_id": null,
              "originating_flag_id": "411486491630370816",
              "category": "invalid",
              "code": "text",
              "name": "text",
              "description": null,
              "schema": null,
              "metadata": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "status": "invalid",
              "requested_by": "invalid",
              "requested_by_detail": null,
              "created_at": "2026-03-10T18:26:45.751Z",
              "updated_at": null,
              "deadline_at": null,
              "submitted_at": null,
              "verified_at": null,
              "rejected_at": null,
              "restricts_capabilities": [
                "text"
              ],
              "submissions": [
                {
                  "id": "411486491630370816",
                  "store_id": "411486491630370816",
                  "store_requirement_id": "411486491630370816",
                  "store_requirement_field_id": "text",
                  "text_value": null,
                  "file_id": null,
                  "file_name": null,
                  "file_content_type": null,
                  "file_size_bytes": null,
                  "submitted_at": "2026-03-10T18:26:45.751Z",
                  "submitted_by": {
                    "type": "anonymous",
                    "id": "411486491630370816"
                  },
                  "submitted_by_ip_address": null,
                  "submitted_by_user_agent": null
                }
              ]
            }
          ]
        },
        "owner_id": "411486491630370816",
        "slug": "text",
        "name": "text",
        "platform": "text",
        "game": "text",
        "currency": "text",
        "description": "text",
        "website_url": null,
        "contact_email": null,
        "support_email": null,
        "support_url": null,
        "integration_type": null,
        "live_mode": true,
        "logo_url": null,
        "logo_square_url": null,
        "minecraft_bedrock_username_prefix": null,
        "created_at": null,
        "updated_at": null,
        "onboarding_completed_at": null,
        "platform_store_type_association": {
          "platform_id": "411486491630370816",
          "associated_platform": {
            "id": "411486491630370816",
            "slug": "text",
            "type": "invalid",
            "country_code": "text",
            "business_name": "text",
            "name": "text",
            "description": "text",
            "website_url": "text",
            "logo_url": "text",
            "accent_color": "text",
            "capabilities": [
              "invalid"
            ],
            "created_at": "2026-03-10T18:26:45.751Z",
            "updated_at": "2026-03-10T18:26:45.751Z",
            "disabled_at": null
          },
          "store_platform": "text",
          "paynow_platform_fee_percentage_override": null,
          "connected_platform_fee_percentage": null,
          "connected_platform_wallet_id": null,
          "disable_billing_plans": true,
          "display_disclaimers": true,
          "full_external_management": true
        },
        "members": [
          {
            "id": "411486491630370816",
            "user_id": "411486491630370816",
            "user": {
              "type": "anonymous",
              "id": "411486491630370816",
              "email": null,
              "first_name": null,
              "last_name": null,
              "nickname": null
            },
            "added_at": null,
            "added_by": {
              "type": "anonymous",
              "id": "411486491630370816"
            },
            "role_id": "411486491630370816"
          }
        ]
      },
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-03-10T18:26:45.751Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "text",
    "product_image_url": null,
    "period_value": 1,
    "period_scale": "text",
    "starts_at": null,
    "ends_at": null,
    "status": "created",
    "created_at": "2026-03-10T18:26:45.751Z",
    "canceled_at": null,
    "canceled_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Get a trial by ID for a store

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

trialIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/trials/{trialId}

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/trials/{trialId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "pretty_id": "text",
  "store_id": "411486491630370816",
  "checkout_id": "411486491630370816",
  "checkout_line_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "store": {
      "id": "411486491630370816",
      "trust": {
        "store_id": "411486491630370816",
        "status": "invalid",
        "status_reason": null,
        "restrictions": "none",
        "created_at": "2026-03-10T18:26:45.751Z",
        "updated_at": null,
        "onboarding_steps": {
          "store_id": "411486491630370816",
          "store_owner_id": "411486491630370816",
          "payout_onboarding_completed": true,
          "kyc_completed": true,
          "products_created": true,
          "gameserver_linked": true,
          "webhooks_active": true,
          "downloadable_files_added": true
        },
        "events": [
          {
            "id": "411486491630370816",
            "store_id": "411486491630370816",
            "type": "invalid",
            "description": null,
            "store_requirement_id": "411486491630370816",
            "store_review_id": "411486491630370816",
            "actor": {
              "type": "anonymous",
              "id": "411486491630370816"
            },
            "created_at": "2026-03-10T18:26:45.751Z"
          }
        ],
        "pending_requirements": [
          {
            "id": "411486491630370816",
            "store_id": "411486491630370816",
            "template_id": null,
            "originating_flag_id": "411486491630370816",
            "category": "invalid",
            "code": "text",
            "name": "text",
            "description": null,
            "schema": null,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "status": "invalid",
            "requested_by": "invalid",
            "requested_by_detail": null,
            "created_at": "2026-03-10T18:26:45.751Z",
            "updated_at": null,
            "deadline_at": null,
            "submitted_at": null,
            "verified_at": null,
            "rejected_at": null,
            "restricts_capabilities": [
              "text"
            ],
            "submissions": [
              {
                "id": "411486491630370816",
                "store_id": "411486491630370816",
                "store_requirement_id": "411486491630370816",
                "store_requirement_field_id": "text",
                "text_value": null,
                "file_id": null,
                "file_name": null,
                "file_content_type": null,
                "file_size_bytes": null,
                "submitted_at": "2026-03-10T18:26:45.751Z",
                "submitted_by": {
                  "type": "anonymous",
                  "id": "411486491630370816"
                },
                "submitted_by_ip_address": null,
                "submitted_by_user_agent": null
              }
            ]
          }
        ]
      },
      "owner_id": "411486491630370816",
      "slug": "text",
      "name": "text",
      "platform": "text",
      "game": "text",
      "currency": "text",
      "description": "text",
      "website_url": null,
      "contact_email": null,
      "support_email": null,
      "support_url": null,
      "integration_type": null,
      "live_mode": true,
      "logo_url": null,
      "logo_square_url": null,
      "minecraft_bedrock_username_prefix": null,
      "created_at": null,
      "updated_at": null,
      "onboarding_completed_at": null,
      "platform_store_type_association": {
        "platform_id": "411486491630370816",
        "associated_platform": {
          "id": "411486491630370816",
          "slug": "text",
          "type": "invalid",
          "country_code": "text",
          "business_name": "text",
          "name": "text",
          "description": "text",
          "website_url": "text",
          "logo_url": "text",
          "accent_color": "text",
          "capabilities": [
            "invalid"
          ],
          "created_at": "2026-03-10T18:26:45.751Z",
          "updated_at": "2026-03-10T18:26:45.751Z",
          "disabled_at": null
        },
        "store_platform": "text",
        "paynow_platform_fee_percentage_override": null,
        "connected_platform_fee_percentage": null,
        "connected_platform_wallet_id": null,
        "disable_billing_plans": true,
        "display_disclaimers": true,
        "full_external_management": true
      },
      "members": [
        {
          "id": "411486491630370816",
          "user_id": "411486491630370816",
          "user": {
            "type": "anonymous",
            "id": "411486491630370816",
            "email": null,
            "first_name": null,
            "last_name": null,
            "nickname": null
          },
          "added_at": null,
          "added_by": {
            "type": "anonymous",
            "id": "411486491630370816"
          },
          "role_id": "411486491630370816"
        }
      ]
    },
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": null
    },
    "steam_id": "76561197960287930",
    "steam": {
      "id": "76561197960287930",
      "name": "text",
      "avatar_url": "text"
    },
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "minecraft": {
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "name": "notch",
      "avatar_url": "text"
    },
    "xbox_xuid": null,
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2026-03-10T18:26:45.751Z",
    "updated_at": null,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "product_id": "411486491630370816",
  "product_version_id": "411486491630370816",
  "product_name": "text",
  "product_image_url": null,
  "period_value": 1,
  "period_scale": "text",
  "starts_at": null,
  "ends_at": null,
  "status": "created",
  "created_at": "2026-03-10T18:26:45.751Z",
  "canceled_at": null,
  "canceled_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Get trial eligibility overrides for a specific customer

get

Retrieves all trial eligibility overrides for the specified customer.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to retrieve trial eligibility overrides for.

Example: 411486491630370816

customerIdstring · flake-idRequired

The ID of the customer to retrieve trial eligibility overrides for.

Example: 411486491630370816

Query parameters

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "product_id": "411486491630370816",
    "product_name": "text",
    "product_image_url": null,
    "created_at": "2026-03-10T18:26:45.751Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "expires_at": "2026-03-10T18:26:45.751Z",
    "used_at": null,
    "used_on_trial_id": "411486491630370816",
    "note": null,
    "deleted_at": null,
    "deleted_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Create trial eligibility override for a customer

post

Creates a new trial eligibility override for the specified customer.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to create the trial eligibility override for.

Example: 411486491630370816

customerIdstring · flake-idRequired

The ID of the customer to create the trial eligibility override for.

Example: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

product_idstring · flake-idRequiredExample: 411486491630370816

expires_atstring · date-timeRequired

notestringOptional

Responses

200

OK

application/json

default

Error response

application/json

post

/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "product_id": "411486491630370816",
  "expires_at": "2026-03-10T18:26:45.751Z",
  "note": "text"
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "pretty_id": "text",
  "store_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "product_id": "411486491630370816",
  "product_name": "text",
  "product_image_url": null,
  "created_at": "2026-03-10T18:26:45.751Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "expires_at": "2026-03-10T18:26:45.751Z",
  "used_at": null,
  "used_on_trial_id": "411486491630370816",
  "note": null,
  "deleted_at": null,
  "deleted_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Delete trial eligibility override for a customer

delete

Deletes an existing trial eligibility override.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to delete the trial eligibility override for.

Example: 411486491630370816

trialEligibilityOverrideIdstring · flake-idRequired

The ID of the trial eligibility override to delete.

Example: 411486491630370816

customerIdstringRequired

Responses

204

No Content

default

Error response

application/json

delete

/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides/{trialEligibilityOverrideId}

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides/{trialEligibilityOverrideId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content