Trials

Get trials for a store

get
Authorizations
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
get
GET /v1/stores/{storeId}/trials HTTP/1.1
Host: 
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",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-09-13T13:13:05.296Z",
      "updated_at": "2025-09-13T13:13:05.296Z",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "text",
    "product_image_url": "text",
    "period_value": 1,
    "period_scale": "text",
    "starts_at": "2025-09-13T13:13:05.296Z",
    "ends_at": "2025-09-13T13:13:05.296Z",
    "status": "created",
    "created_at": "2025-09-13T13:13:05.296Z",
    "canceled_at": "2025-09-13T13:13:05.296Z",
    "canceled_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Get a trial by ID for a store

get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
trialIdstring · flake-idRequiredExample: 411486491630370816
Responses
200

OK

application/json
get
GET /v1/stores/{storeId}/trials/{trialId} HTTP/1.1
Host: 
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",
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": "text"
    },
    "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": "text",
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2025-09-13T13:13:05.296Z",
    "updated_at": "2025-09-13T13:13:05.296Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "product_id": "411486491630370816",
  "product_version_id": "411486491630370816",
  "product_name": "text",
  "product_image_url": "text",
  "period_value": 1,
  "period_scale": "text",
  "starts_at": "2025-09-13T13:13:05.296Z",
  "ends_at": "2025-09-13T13:13:05.296Z",
  "status": "created",
  "created_at": "2025-09-13T13:13:05.296Z",
  "canceled_at": "2025-09-13T13:13:05.296Z",
  "canceled_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}
PreviousTrial EligibilityNextWebhooks

Was this helpful?